Developer’s Guide¶
Bug reports and feature requests¶
Developer Setup¶
vcstools uses setuptools,
which you will need to download and install in order to run the
packaging. We use setuptools instead of distutils in order to be able
use setup() keys like install_requires.
cd vcstools python setup.py develop
Testing¶
Install test dependencies
pip install nose
pip install mock
vcstools uses Python nose for testing, which is
a fairly simple and straightfoward test framework. The vcstools
mainly use unittest to construct test fixtures, but with nose
you can also just write a function that starts with the name test
and use normal assert statements.
vcstools also uses mock to create mocks for testing.
You can run the tests, including coverage, as follows:
cd vcstools
make test
Documentation¶
Sphinx is used to provide API documentation for vcstools. The documents
are stored in the doc subdirectory.