minizen-template 0.3.1

A template repo for python projects

Python project Template

This is a template repository for python projects.

To get started:

1. Create a repository on GitHub using this template.
2. Setup commitizen workflow for version and changelog generation
3. Setup zensical workflow for documentation hosting
4. Setup renovate for dependency updates
5. Setup PyPI publishing workflow for package distribution
6. Enable nix devshells for development environment setup with nix develop
7. Enable pre-commit with prek install
8. Reset versioning for your project by running the following script:

#!/usr/bin/env bash
# Reset repository versioning to 0.0.0

# Clear changelog
echo "" > CHANGELOG.md

# Update version in pyproject.toml
sed -i 's/^version = "[^"]*"/version = "0.0.0"/' pyproject.toml

# Update version in commitizen version_files
sed -i 's/__version__ = "[^"]*"/__version__ = "0.0.0"/' src/minizen_template/__init__.py