Skip to content

Lee-W/cookiecutter-python-template

Repository files navigation

PRs Welcome Conventional Commits Github Actions

Cookiecutter Python Template

Features

  • pipenv or poetry: dependency and virtual environment management
  • Coding style
    • ruff: check style
    • mypy: check static type
  • Test thought pytest with the following supports
  • commitizen:
    • regulate git commit convention
    • bump project version
    • generate changelog automatically
  • mkdocs: generate documentation
  • invoke: organize the tools above
  • pre-commit: git-hook to run the above tools automatically
  • GitHub
    • GitHub Actions workflows for checking style, testing, publishing package to PyPI and pushing documentation to GitHub pages
    • GitHub issue templates, pull request template
  • General Python project Dockerfile
  • Consolidate most of the tool configurations in pyproject.toml

Getting Started

Prerequisites

Usage

cruft create https://github.com/Lee-W/cookiecutter-python-template

Authors

Lee-W

About

Python Project template that supports PyPI publishment and basic docker image

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published