Contains python project quickstart template. Uses virtualenv to install project dependencies. Uses GNU make to execute common tasks
To start you need to make the following steps:
- Clone the project using command
git clone git@github.com:radiophysicist/python-template-project.git - Specify project name and python version in the
Makefile - Add necessary dependencies in the
requirements.txtfile - Initialize virtualenv with command
make venv - Activate virtualenv in the sh-compatible linux shell with command
source venv_activate
To generate Doxygen documentation
use command
make doc
(in addition to doxygen, doxypy and graphviz required)
To run unittest use command
make unit
To run unittest with generating coverage report use command
make unit-coverage
To run test you may need to uncomment test packages in requirements.txt