CONTRIBUTING.md

Contributing

Dependencies

With the exception of chromedriver, this project uses pipenv to manage its dependencies.

• add a dependency: pipenv install myNewDep
• add a dev dependency: pipenv install --dev myNewDep
• remove dependency: pipenv uninstall myNewDep

Once you are happy with the content of the Pipfile file, run the following tool to synchronize the dependencies to the packaging setup.py file:

$ ./tools/update-dependencies.sh

Testing

We use nose to run our tests:

$ pipenv run nosetests --verbosity=3

To also run the slow tests that require network:

$ TEST_ENABLE_NETWORK=1 pipenv run nosetests --verbosity=3