dye-score

Utilities to build the dye-score metric from OpenWPM javascript call data.

Перейти к файлу

Sarah Bird 789dd458ba Bump version: 0.11.2 → 0.11.3		2019-05-31 14:28:48 -05:00
.github	Bulk add library	2019-03-30 02:57:28 -05:00
docs	Add plotting utils to api docs (loosely)	2019-05-18 10:57:40 -05:00
dye_score	Bump version: 0.11.2 → 0.11.3	2019-05-31 14:28:48 -05:00
tests	Fix path removal	2019-05-31 13:59:30 -05:00
.editorconfig	Bulk add library	2019-03-30 02:57:28 -05:00
.gitignore	Improve docs, clean up to compute dye score	2019-04-01 01:04:43 -05:00
.travis.yml	Travis doesn't like py3.7 at the moment	2019-04-01 02:49:39 -05:00
CODE_OF_CONDUCT.rst	Update docs with history and coc	2019-05-18 10:47:57 -05:00
CONTRIBUTING.rst	Add reminder about releasing	2019-04-26 18:29:44 -05:00
HISTORY.rst	Distance tests and new functions (#30 )	2019-05-21 15:32:22 -05:00
LICENSE	Initial commit	2019-03-28 14:23:05 -05:00
MANIFEST.in	Bulk add library	2019-03-30 02:57:28 -05:00
Makefile	Improve docs, clean up to compute dye score	2019-04-01 01:04:43 -05:00
README.rst	Add conda install instructions	2019-04-17 13:09:04 -05:00
requirements_dev.txt	Add nbsphinx requirement	2019-04-01 02:25:32 -05:00
setup.cfg	Bump version: 0.11.2 → 0.11.3	2019-05-31 14:28:48 -05:00
setup.py	Bump version: 0.11.2 → 0.11.3	2019-05-31 14:28:48 -05:00

README.rst

=========
Dye Score
=========

.. image:: https://readthedocs.org/projects/dyescore/badge/?version=latest
    :target: https://dyescore.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
.. image:: https://travis-ci.org/mozilla/dye-score.svg?branch=master
    :target: https://travis-ci.org/mozilla/dye-score


Utilities to build the dye-score metric from OpenWPM_ javascript call data.


* GitHub repo: https://github.com/mozilla/dye-score/
* Documentation: https://dyescore.readthedocs.io/
* Free software: Mozilla Public License

Quickstart
----------

Install dye score: ``conda install dye-score -c conda-forge`` or ``pip install dye-score``

Review usage notebook: https://github.com/mozilla/dye-score/blob/master/docs/usage.ipynb

.. _OpenWPM: https://github.com/mozilla/openwpm