This package is intended to demonstrate the basic package layout suitable for easy development and distribution.
Installation into a Python environment for development is achieved by running:
pip install -r dev-tools.txt -e .from inside the directory containing the package, i.e., the directory containing setup.py.
The package will be installed into the environment via a reference to the source files in this directory (this is the effect of the -e switch). As a result, changes to the package will be visible to client code running in the environment without repeating the installation step.
The -r switch indicates additional packages to install.
It is recommended that a distinct virtual environment be used for development.
The command above will attempt to install the requirements from the normal Python package index. This may be undesirable, and will typically require proxy configuration. Additional command line options are available to instruct pip to search a particular location instead for distributions.
nosetests --config=nose.cfgSimply run:
python setup.py bdist_wheelAppropriate defaults are set in setup.cfg.
In the docs directory, run:
make htmlThe documentation is generated by Sphinx. See the Sphinx documentation and this tutorial for details.