A modern Python package template with comprehensive tooling and CI/CD setup.
- 📦 Package configuration with
pyproject.tomlbuilt withhatch - 🎨 Code formatting and linting with
ruffandblack - 🐳 Ready-to-use
Dockerfilewith package installation - 🔄 Git hooks with
pre-commitconfiguration - 💻 GitHub Codespaces support via
.devcontainer - 🚀 CI/CD Pipelines with GitHub Actions
- 🧪 Basic
pytestsetup for unit tests - 📚 Auto-generated docs with
mkdocsandmkdocs-material
Replace the following placeholders in the codebase:
| Placeholder | Description | Example |
|---|---|---|
REPLACE_PACKAGE_NAME |
Package name (usually repository name) | awesome_project |
REPLACE_REPO_NAME |
GitHub repository name | awesome-project |
REPLACE_PACKAGE_DESCRIPTION |
Brief package description | A tool for awesome things |
REPLACE_FULL_NAME |
Your full name | John Doe |
REPLACE_EMAIL |
Your email address | [email protected] |
REPLACE_GITHUB_USERNAME |
Your GitHub username | johndoe |
Add your PYPI_TOKEN to repository secrets for package publishing.
Enable write permissions for GITHUB_TOKEN:
- Navigate to
Settings>Actions>Generalin your repository - Under
Workflow permissions, selectRead and write permissions - Click
Saveto apply changes
This project is licensed under the MIT License - see the LICENSE file for details.