python_project_template

A Python project template.

Includes

1. A Dev Container with Python 3.11 and Docker-In-Docker.
2. Visual Studio Code code quality extensions and configurations.
3. Pre-commit code quality configurations.
4. Dependabot configurations to update requirements.
5. A script which runs pytest.
6. A GitHub workflow which runs pre-commit.
7. A GitHub workflow which runs pytest.
8. A GitHub workflow which runs pre-commit and pytest on pull requests.

Requirements

1. VS Code
2. Dev Containers Extension
3. Docker

Required for use outside of GitHub Codespaces.

Running Tests

GitHub

Open a pull request.

Local Environment

Execute the following command:

python tests/run_pytest.py

This will create htmlcov/, coverage.xml, and results.xml in the tests/results folder.

Troubleshooting

If a VS Code extension is not working, open the Command Palette and run the Developer: Reload Window command to refresh VS Code.