If you plan to submit a pull request, you should first fork the mwclient repo on GitHub, then clone your own fork:
$ git clone email@example.com:MYUSERNAME/mwclient.git $ cd mwclient
You can then use pip to do an “editable” install so that your edits will be immediately available for (both interactive and automated) testing:
$ pip install -e .
mwclient ships with a test suite based on pytest. While it’s far from complete, it can sometimes alert you if you break things.
The easiest way to run the tests is:
$ python setup.py test
This will make an in-place build and download test dependencies locally if needed. Tests will run faster, however, if you do an editable install and run pytest directly:
$ pip install pytest pytest-cov flake8 responses mock $ pip install -e . $ py.test
If you want to test with different Python versions in isolated virtualenvs, you can use Tox. A tox.ini file is included.
$ pip install tox $ tox
If you would like to expand the test suite by adding more tests, please go ahead!
Updating/expanding the documentation¶
Documentation consists of both a manually compiled user guide
docs/user) and a reference guide generated from the docstrings,
using Sphinx autodoc with the napoleon extension.
Documentation is built automatically on ReadTheDocs
after each commit.
To build the documentation locally for testing:
$ pip install Sphinx sphinx-rtd-theme $ cd docs $ make html
When writing docstrings, try to adhere to the Google style.
Making a pull request¶
Make sure to run tests before committing. When it comes to the commit message, there’s no specific requirements for the format, but try to explain your changes in a clear and concise manner.
If it’s been some time since you forked, please consider rebasing your branch on the main master branch to ease merging:
$ git remote add upstream https://github.com/mwclient/mwclient.git $ git rebase upstream master
Then push your code and open a pull request on GitHub.