This is a template repository for creating new Python libraries. It includes a basic structure, a dummy Python package, unit tests, and GitHub Actions workflows for testing and deployment. I am sharing this template in case others find it useful.
- Poetry (or uv): for dependency management, packaging, publishing, etc.
- Makefile: for managing common tasks like testing, linting, and formatting.
- GitHub Actions: for running tests, linting, and deploying to PyPI.
- Badges: for showing the status of tests, code quality, version, etc.
- Default files: for configuration, testing, and documentation, like
.gitignore,README.md,LICENSE, etc.
Python>= 3.10Poetry 2.0+(or any other modern Python dependency manager likeuv)GNU Make
Use the Use this template button on GitHub to create a new repository based on this template.
Modify the README.md file and other files as needed.
Run make help to see all available commands for managing different tasks.
See CONTRIBUTING.md for details on how to make a contribution.
This template is licensed under the MIT License (LICENSE or https://opensource.org/licenses/MIT)