Python Packages Project Generator

TL;DR

cookiecutter gh:TezRomacH/python-package-template

🚀 Features

In this cookiecutter template, we aimed to combine the most state-of-the-art libraries and best development practices for Python.

For your development we've prepared:

• Supports for Python 3.7 and higher.
• Poetry as the dependencies manager. See configuration in pyproject.toml and setup.cfg.
• Power of black, isort and pyupgrade formatters.
• Ready-to-use pre-commit hooks with formatters above.
• Type checks with the configured mypy.
• Testing with pytest.
• Docstring checks with darglint.
• Security checks with safety and bandit.
• Well-made .editorconfig, .dockerignore, and .gitignore. You don't have to worry about those things.

For building and deployment:

• GitHub integration.
• Makefile for building routines. Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc. More details at Makefile summary).
• Dockerfile for your package.
• Github Actions with predefined build workflow as the default CI/CD.
• Always up-to-date dependencies with @dependabot (You will only enable it).
• Automatic drafts of new releases with Release Drafter. It creates a list of changes based on labels in merged Pull Requests. You can see labels (aka categories) in release-drafter.yml. Works perfectly with Semantic Versions specification.

For creating your open source community:

• Ready-to-use Pull Requests templates and several Issue templates.
• Files such as: LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md are generated automatically.
• Stale bot that closes abandoned issues after a period of inactivity. (You will only need to setup free plan). Configuration is here.
• Semantic Versions specification with Release Drafter.

🤯 How to use it

Installation

Before creating a new project from this template, you need to install the dependencies:

pip install -U cookiecutter lice

Go to the directory where you want to create your project and run:

cookiecutter gh:TezRomacH/python-package-template

Input variables

The cookiecutter generator will ask you for some data, you might want to have at hand before generating the project.

The input variables, with their default values (some auto-generated), are:

The entered values will be saved in the cookiecutter-config-file.yml file so that you don't lose them. 😉

Demo

More details

After using this generator, your new project (the directory created) will contain an extensive README.md with instructions for development, deployment, etc. You can pre-read the project README.md template here too.

Initial setting up

Initialize .git, poetry and pre-commit

By running make install

After you run the cookiecutter command and the project appears in your directory, the console will display a message about how to initialize the project.

Package example

All manipulations with dependencies are executed through Poetry. If you're new to it, look through the documentation.

The template comes with a cute little CLI application example. It uses Typer to CLI and Rich for beautiful formatting in the terminal output.

After installation via make install (preferred) or poetry install you can try to play with the example:

poetry run <project_name> --help

poetry run <project_name> --name Roman

Building and releasing your package

Building a new version of the application contains steps:

• Bump the version of your package poetry version <version>. You can pass the new version explicitly, or a rule such as major, minor, or patch. For more details, refer to the Semantic Versions standard.
• Make a commit to GitHub.
• Create a GitHub release.
• And... publish 🙂 poetry publish --build

Makefile usage

Makefile contains many functions for fast assembling and convenient work.

make download-poetry

make install

make install NO_PRE_COMMIT=1

make check-safety

make check-safety STRICT=1

make check-safety SAFETY_STRICT=1

make check-safety PIP_STRICT=1 SAFETY_STRICT=1

make check-style

make check-style STRICT=1

make codestyle

make test

make lint

make test && make check-safety && make check-style

make docker

make docker VERSION=latest

make clean_docker

make clean

🎯 What's next

Well, that's up to you. I can only recommend the packages and articles that helped me.

Packages:

• Typer is great for creating CLI applications.
• Rich makes it easy to add beautiful formatting in the terminal.
• FastAPI is a type-driven asynchronous web framework.
• IceCream is a little library for sweet and creamy debugging.
• Returns makes you function's output meaningful, typed, and safe!
• Pydantic – data validation and settings management using Python type hinting.

Articles:

• Open Source Guides.
• GitHub Actions Documentation.
• Maybe you would like to add gitmoji to commit names. This is really funny. 😄

📈 Releases

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification.

We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

For Pull Request we configured this labels:

🧪 TODOs

This template will continue to develop and follow the bleeding edge new tools and best practices to improve the Python development experience.

Here is a list of things that have yet to be implemented:

• Add examples of libraries created using this template.
• Tests coverage reporting (Codecov ?).
• Builtin integration with Code Climate, Deepsource and CodeFactor (they are free for Open Source).
• Auto uploading your package to PyPI.
• Automatic creation and deployment of documentation to GitHub pages (I'm mostly looking at MkDocs with Material Design theme and mkdocstrings).
• Code metrics with Radon.
• Docstring coverage with interrogate
• Dockerfile linting with dockerfilelint.
• Hall of fame from Sourcerer.
• Some advanced Python linting (?).
• Refactor Makefile
• Help text for all functions in Makefile.
• Add the option to select the minimum version of Python: 3.7 or 3.8
• End-to-end testing and validation of the cookiecutter template.

🛡 License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

🏅 Acknowledgements

This template was inspired by those great articles:

• Hypermodern Python
• Ultimate Setup for Your Next Python Project
• Nine simple steps for better-looking python code

and repositories:

• Cookiecutter
• wemake-python-package
• Audreyr's cookiecutter-pypackage
• Full Stack FastAPI and PostgreSQL - Base Project Generator
• Cookiecutter Data Science Template: cdst

Give them your ⭐️, these resources are amazing! 😉

📃 Citation

@misc{python-package-template,
  author = {Roman Tezikov},
  title = {Python Packages Project Generator},
  year = {2020},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/TezRomacH/python-package-template}}
}