Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 931 Bytes

README.md

File metadata and controls

44 lines (30 loc) · 931 Bytes

CMI Python-project template

Template for new CMI Python-software projects.

This includes the basic setup of a Python project with library, scripts, pytest testing, and sphinx documentation.

Installation

Standard setuptool installation, run

python setup.py install

or advanced versions using develop, --user, etc. – see the documentation for more details.

Documentation

See this very sphinx-generated documentation for further details; it can be produced by running

python setup.py build_sphinx

See also the license.

Testing

Standard tests are implemented in tests/, run by executing

pytest