/python-template-project

python virtualenv-based project quickstart template

Primary LanguageMakefile

Python virtualenv template project

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:

  1. Clone the project using command git clone git@github.com:radiophysicist/python-template-project.git
  2. Specify project name and python version in the Makefile
  3. Add necessary dependencies in the requirements.txt file
  4. Initialize virtualenv with command make venv
  5. 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