If you want to know more about contributing on Setuptools, this is the place.
Table of Contents
Please read How to write the perfect pull request for some tips on contributing to open source projects. Although the article is not authoritative, it was authored by the maintainer of Setuptools, so reflects his opinions and will improve the likelihood of acceptance and quality of contribution.
Setuptools is maintained primarily in Github at this home. Setuptools is maintained under the Python Packaging Authority (PyPA) with several core contributors. All bugs for Setuptools are filed and the canonical source is maintained in Github.
User support and discussions are done through the issue tracker (for specific) issues, through the distutils-sig mailing list, or on IRC (Freenode) at #pypa.
Discussions about development happen on the pypa-dev mailing list or on IRC (Freenode) at #pypa-dev.
Grab the code at Github:
$ git checkout https://github.com/pypa/setuptools
If you want to contribute changes, we recommend you fork the repository on Github, commit the changes to your repository, and then make a pull request on Github. If you make some changes, don’t forget to:
- add a note in CHANGES.rst
Please commit all changes in the ‘master’ branch against the latest available commit or for bug-fixes, against an earlier commit or release in which the bug occurred.
If you find yourself working on more than one issue at a time, Setuptools generally prefers Git-style branches, so use Mercurial bookmarks or Git branches or multiple forks to maintain separate efforts.
The Continuous Integration tests that validate every release are run from this repository.
For posterity, the old Bitbucket mirror is available.
The primary tests are run using py.test. To run the tests:
$ python setup.py test
Or install py.test into your environment and run
python -m pytest.
Under continuous integration, additional tests may be run. See the
.travis.yml file for full details on the tests run under Travis-CI.
Setuptools relies on the Sphinx system for building documentation and in
build_sphinx distutils command. To build the
python setup.py build_sphinx
from the root of the repository. Setuptools will download a compatible build of Sphinx and any requisite plugins and then build the documentation in the build/sphinx directory.
Setuptools does not support invoking the doc builder from the docs/ directory as some tools expect.