documentation for pytemplate’s¶
- pytemplate is an example python library meant to demostrate how to:
- use nose to write unit tests
- use numpy, pandas, and matplotlib speciality testing functions
- use Travis CI to run unit tests
- use Coveralls.io to examine and report test coverage
- use restructured text, sphinx, andreadthedocs.org to document your code.
Dependencies¶
Installation¶
- Activate your conda environment;
- Clone my fork from Github;
- Change to that resulting directory;
- Install via pip; and
- Back out of that directory to use
source activate metar # (omit "source" on Windows)
git clone https://github.com/phobson/pytemplate
cd pytemplate
pip install .
cd ../..
Testing¶
Tests are run via nose. Run them all with:
source activate pytemplate # (omit "source" on Windows)
python -c "import pytemplate; pytemplate.test()"
You can get fancy with:
python -c "import pytemplate; pytemplate.test(verbose=2, packageinfo=True, coverage=True)"