Ready to contribute? Here’s how to set up Watson for local development.
- Fork the Watson repository on GitHub.
Clone your fork locally:
$ git clone firstname.lastname@example.org:your_name_here/Watson.git
Install Watson locally:
$ mkvirtualenv watson $ cd Watson $ pip install -r requirements-dev.txt $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass the tests (see Run the tests):
If you have added a new command or updated/fixed docstrings, please update the documentation:
$ make docs
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push -u origin name-of-your-bugfix-or-feature
After reading this, submit a pull request through the GitHub website.
Run the tests
The tests use pytest. To run them with the default Python interpreter:
$ py.test -v tests/
To run the tests via tox with all Python versions
which are available on your system and are defined in the
This will also check the source code with flake8.