jackycwwang / Python-Project-Template-Eng

FastVector

Template For Python Projects

This is a template for Python projects. What you get:

• Source code and test code is seperated in different directories.
• External libraries installed and managed by Pip.
• Setup for tests using Pytest.
• Continuous testing with Github-Actions.
• Code coverage reports, including automatic upload to Codecov.
• Code documentation with Mkdocs.
• Optional: Use of VSCode with the Python and UnitTest extension.

Structure

├── setup.py
├── setup.cfg
├── pyproject.toml
├── ... other config files ...
├── tests
│   ├── __init__.py
│   └── test_vector.py
├── docs
│   ├── api.md
│   └── index.md
├── fastvector
│   ├── __init__.py
│   ├── vector.py
│   └── version.py
└── tests
    ├── __init__.py
    └── test_vector.py

Commands

# Build and Install (local)
pip install -e .

# Test
pytest tests

# Code Coverage
pytest --cov=fastvector tests --cov-report=html