The package template is most useful when the final goal is the release of software to a registry, e.g. pypi. It features include
- Uses uv for dependency management and hatch for build management
- Offers a list of curated pre-commit hooks
- GitHub Actions for continuous integration
- Automated testing with pytest
- Code formatting with ruff
- Interactive notebooks with marimo
- Documentation generation with pdoc
- Support of a DevContainer
make fmt # Install pre-commit hooks and run them on all files
- Fork the repository
- Create your feature branch (git checkout -b feature/amazing-feature)
- Commit your changes (git commit -m 'Add some amazing feature')
- Push to the branch (git push origin feature/amazing-feature)
- Open a Pull Request
Thomas Schmelzer - @tschm
Project Link: https://github.com/tschm/package