This repository will provide a starting template for new Python-based projects. Here we pick a set of tools that we are familiar with; however, there are many tools extant that have similar functionality.
The following tools will be used:
- GitHub - Version Control
- Travis CI - Continous Integration
- pytest - Unit and Regression Testing
- CodeCov - Testing Coverage Analysis
- Read the Docs - Documentation
To run the test suite please first run
pip install -e . in the base
repository folder. This will register this repository with your local Python so
import python_template will work in any directory. Tests can then be run
py.test -v. If
pytest is not found please use
pip install pytest to
aquire the module.