This project provides a template for Python projects. It uses
- setuptools for distribution
- sphinx for documentation
- flake8 for code style checks
- tox, pytest and coverage for testing
- versioneer to auto-update the version string
skltn is inspired by https://github.com/rocktavious/python-project-template
-
Clone this repository
git clone https://github.com/ksonj/skltn my_project cd my_project -
Edit the metadata in
skltn/metadata.py. -
Then run
python skltn/generate.pyThis will fill the templates with the data provided in
skltn/metadata.py, remove the original.gitdirectory and initialize a fresh git repository. -
Replace this README and the LICENSE with your own versions
The scripts in tools/ serve the following purposes:
docs.sh: Create the documentation via sphinxtest.sh: Run tests viapytestand report withcoverage.