P3G - Python Packages Project Generator

English 中文

> This version is fork from https://github.com/TezRomacH/python-package-template. As a comparison, the current project provides better compatibility with Windows and faster lint construction. And a more lightweight way to create.

TL;DR

If you don't want to read the whole README, just click the Use this template button and start coding your Python package right now! 🚀

pip install p3g -U
p3g generate

🚀 Features

In this cookiecutter 🍪 template we combine state-of-the-art libraries and best development practices for Python.

Development features

• Supports Python 3.7 and higher.
• Poetry as a dependencies manager. See configuration in pyproject.toml and setup.cfg.
• Faster formatter tool, automatic codestyle with ruff to replace black, isort and pyupgrade.
• Ready-to-use pre-commit hooks with code-formatting.
• Type checks with ruff; docstring checks with darglint; security checks with safety and bandit
• Testing with pytest.
• Ready-to-use .editorconfig, .dockerignore, and .gitignore. You don't have to worry about those things.
• The ability of building docker.

Deployment features

• GitHub integration: issue and pr templates.
• Github Actions with predefined build workflow as the default CI/CD.
• Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with Makefile. More details in makefile-usage.
• Dockerfile for your package.
• Always up-to-date dependencies with @dependabot. You only need to enable it.
• Automatic release notes with Release Drafter. You may see the list of labels in release-drafter.yml. Works perfectly with Semantic Versions specification.

Open source community features

• 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

To begin using the template consider updating p3g

pip install -U p3g

then go to a directory where you want to create your project and run:

p3g generate

Input variables

Template generator will ask you to fill some variables.

The input variables, with their default values:

All input values will be saved in the cookiecutter-config-file.yml file so that you won't lose them. 😉

Demo

More details

Your project will contain README.md file with instructions for development, deployment, etc. You can read the project README.md template before.

Initial set up

Initialize poetry

By running pip install poetry & make install

After you create a project, it will appear in your directory, and will display a message about how to initialize the project.

Initialize pre-commit

pre-commit is already installed if you initialize git repo before running make install. If it fails without initialization, run make install again to install pre-commit to .git.

Package example

Want to know more about Poetry? Check its documentation.

CLI example

If you set create_example_template to be cli the template comes with a cute little CLI application example. It utilises Typer and Rich for CLI input validation and beautiful formatting in the terminal.

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

poetry run  --help

poetry run  --name Roman

Building and releasing your package

Building a new version of the application contains steps:

• Bump the version of your package poetry 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 a lot of functions for faster development.

make install

make pre-commit-install

make format

make check-codestyle

make check-safety

make check-safety

make test

make lint

make check-codestyle && make test && make check-safety

make docker-build

make docker-build VERSION=latest

make docker-remove

make pycache-remove

make build-remove

make dsstore-remove

make mypycache-remove

make cleanup

🎯 What's next

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

• Typer is great for creating CLI applications.
• Rich makes it easy to add beautiful formatting in the terminal.
• Pydantic – data validation and settings management using Python type hinting.
• Loguru makes logging (stupidly) simple.
• tqdm – fast, extensible progress bar for Python and CLI.
• IceCream is a little library for sweet and creamy debugging.
• orjson – ultra fast JSON parsing library.
• Returns makes you function's output meaningful, typed, and safe!
• Hydra is a framework for elegantly configuring complex applications.
• FastAPI is a type-driven asynchronous web framework.

Articles:

• Open Source Guides.
• A handy guide to financial support for open source
• 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.

List of labels and corresponding titles

🧪 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:

• Tests coverage reporting (Codecov ?).
• Auto uploading your package to PyPI when new GitHub release is created.
• Automatic creation and deployment of documentation to GitHub pages. I look 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 (?).
• End-to-end testing and validation of the cookiecutter template.
• Add Earthly

🛡 License

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

🏅 Acknowledgements

This template was inspired by several great articles:

• Hypermodern Python
• Ultimate Setup for Your Next Python Project
• Nine simple steps for better-looking python code
• Modern Python developer's toolkit

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 = {Zeeland},
  title = {Python Packages Project Generator},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/Undertone0809/python-package-template}}
}

Markdown source for the badge

[![🚀 Your next Python package needs a bleeding-edge project structure.](https://img.shields.io/badge/python--package--template-%F0%9F%9A%80-brightgreen)](https://github.com/Undertone0809/python-package-template)