python-template

Getting started

1. Create on GitHub

2. Using GitHub CLI

gh repo create my-project --template ionite34/python-template

3. Cloning

git clone https://github.com/ionite34/python-template

Features

📦 Dependency Management - Poetry

💾 Cached workflow builds for GitHub Actions

🧪 Testing and Coverage

• Pre-commit enabled with pre-commit.ci

• Uses GitHub Actions with pytest, coverage.py, and Codecov

  coverage.yml

  First runs tests and coverage on Python 3.10 with Ubuntu, uploads results to Codecov

  tests.yml

  If coverage passes, runs 12 extended matrix tests on Python 3.7 - 3.10 with Ubuntu, Windows, macOS

⚖️ License Compliance Scan

• Verify that all linked dependencies are compatible with your open-source license type
• Requires repository secret: FOSSA_API

🏗️ Automatic Build and Publish to PyPI

• Requires repository secret: PYPI_TOKEN
• Action will start on new published releases
• Requires tests actions on the branch to be passing

🔬 Code quality issues and auto-transforms - DeepSource

• Requires DEEPSOURCE_DSN

Required Repository Tokens

PYPI_TOKEN
FOSSA_API
DEEPSOURCE_DSN

Requirements

pytest >= 7.1.2
pytest-cov >= 3.0.0
mypy = ~= 0.961
pylint >= 2.14.4
black >= 22.6.0
tox ~= 3.25.1
pre-commit >= 2.20.0

License

The code in this template is released under the MIT License.