# P3G - Python Packages Project Generator
[English](README.md) [δΈζ](README_zh.md)
<div align="center">
[](https://github.com/Undertone0809/python-package-template/actions?query=workflow%3Abuild)
[](https://github.com/Undertone0809/python-package-template/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
[](https://github.com/Undertone0809/python-package-template)
[](https://github.com/psf/black)
[](https://github.com/Undertone0809/python-package-template/blob/main/.pre-commit-config.yaml)
[](https://github.com/Undertone0809/python-package-template/releases)
[](https://github.com/Undertone0809/python-package-template/blob/main/LICENSE)
Your next Python package needs a bleeding-edge project structure.
</div>
> This version is fork from [https://github.com/TezRomacH/python-package-template](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! π
```bash
pip install p3g
p3g generate
```
## π Features
In this [cookiecutter πͺ](https://github.com/cookiecutter/cookiecutter) template we combine state-of-the-art libraries and best development practices for Python.
### Development features
- Supports `Python 3.7` and higher.
- [`Poetry`](https://python-poetry.org/) as a dependencies manager. See configuration in [`pyproject.toml`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/pyproject.toml) and [`setup.cfg`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/setup.cfg).
- Faster formatter tool, automatic codestyle with [`ruff`](https://github.com/astral-sh/ruff) to replace [`black`](https://github.com/psf/black), [`isort`](https://github.com/timothycrosley/isort) and [`pyupgrade`](https://github.com/asottile/pyupgrade).
- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with code-formatting.
- Type checks with [`ruff`](https://github.com/astral-sh/ruff); docstring checks with [`darglint`](https://github.com/terrencepreilly/darglint); security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit)
- Testing with [`pytest`](https://docs.pytest.org/en/latest/).
- Ready-to-use [`.editorconfig`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.editorconfig), [`.dockerignore`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.dockerignore), and [`.gitignore`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.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](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/workflows/build.yml) as the default CI/CD.
- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with [`Makefile`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/Makefile#L89). More details in [makefile-usage](#makefile-usage).
- [Dockerfile](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/docker/Dockerfile) for your package.
- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/). You only need to [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates).
- Automatic release notes with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). You may see the list of labels in [`release-drafter.yml`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.
### Open source community features
- Ready-to-use [Pull Requests templates](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/Undertone0809/python-package-template/tree/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/ISSUE_TEMPLATE).
- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.
- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/.stale.yml).
- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).
## π€― How to use it
### Installation
To begin using the template consider updating `p3g`
```bash
pip install -U p3g
```
then go to a directory where you want to create your project and run:
```bash
p3g generate
```
### Input variables
Template generator will ask you to fill some variables.
The input variables, with their default values:
| **Parameter** | **Default value** | **Description** |
|:---------------------:|:---------------------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `project_name` | `python-project` | [Check the availability of possible name](http://ivantomic.com/projects/ospnc/) before creating the project. |
| `project_description` | based on the `project_name` | Brief description of your project. |
| `organization` | based on the `project_name` | Name of the organization. We need to generate LICENCE and to specify ownership in `pyproject.toml`. |
| `license` | `MIT` | One of `MIT`, `BSD-3`, `GNU GPL v3.0` and `Apache Software License 2.0`. |
| `minimal_python_version` | `3.7` | Minimal Python version. One of `3.7`, `3.8` and `3.9`. It is used for builds, GitHub workflow and formatters (`black`, `isort` and `pyupgrade`). |
| `github_name` | based on the `organization` | GitHub username for hosting. Also used to set up `README.md`, `pyproject.toml` and template files for GitHub. |
| `email` | based on the `organization` | Email for `CODE_OF_CONDUCT.md`, `SECURITY.md` files and to specify the ownership of the project in `pyproject.toml`. |
| `version` | `0.1.0` | Initial version of the package. Make sure it follows the [Semantic Versions](https://semver.org/) specification. |
| `line_length` | 88 | The max length per line (used for codestyle with `black` and `isort`). NOTE: This value must be between 50 and 300. |
| `using_tsinghua_image_source` | false | The tsinghua poetry image source |
| `create_example_template` | `cli` | If `cli` is chosen generator will create simple CLI application with [`Typer`](https://github.com/tiangolo/typer) and [`Rich`](https://github.com/willmcgugan/rich) libraries. One of `cli`, `none` |
All input values will be saved in the `cookiecutter-config-file.yml` file so that you won't lose them. π
#### Demo
[](https://www.youtube.com/watch?v=dpKlGRgVp6g "Create a cool Python project structure with p3g")
### More details
Your project will contain `README.md` file with instructions for development, deployment, etc. You can read [the project README.md template](https://github.com/Undertone0809/python-package-template/tree/main/%7B%7B%20cookiecutter.project_name%20%7D%7D) 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](https://github.com/Undertone0809/python-package-template/tree/main/%7B%7B%20cookiecutter.project_name%20%7D%7D#very-first-steps).
#### 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](https://python-poetry.org/docs/).
<details>
<summary>Details about Poetry</summary>
<p>
Poetry's [commands](https://python-poetry.org/docs/cli/#commands) are very intuitive and easy to learn, like:
- `poetry add numpy@latest`
- `poetry run pytest`
- `poetry publish --build`
etc
</p>
</details>
#### CLI example
If you set `create_example_template` to be `cli` the template comes with a cute little CLI application example. It utilises [`Typer`](https://github.com/tiangolo/typer) and [`Rich`](https://github.com/willmcgugan/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:
```bash
poetry run <project_name> --help
```
```bash
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](https://semver.org/) standard.
- Make a commit to `GitHub`.
- Create a `GitHub release`.
- And... publish π `poetry publish --build`
### Makefile usage
[`Makefile`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/Makefile) contains a lot of functions for faster development.
<details>
<summary>1. Install all dependencies and pre-commit hooks</summary>
<p>
Install requirements:
```bash
make install
```
Pre-commit hooks coulb be installed after `git init` via
```bash
make pre-commit-install
```
</p>
</details>
<details>
<summary>2. Codestyle and type checks</summary>
<p>
Automatic formatting uses `ruff`.
```bash
make polish-codestyle
# or use synonym
make formatting
```
Codestyle checks only, without rewriting files:
```bash
make check-codestyle
```
> Note: `check-codestyle` uses `ruff` and `darglint` library
</p>
</details>
<details>
<summary>3. Code security</summary>
<p>
```bash
make check-safety
```
This command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.
```bash
make check-safety
```
</p>
</details>
<details>
<summary>4. Tests with coverage badges</summary>
<p>
Run `pytest`
```bash
make test
```
</p>
</details>
<details>
<summary>5. All linters</summary>
<p>
Of course there is a command to run all linters in one:
```bash
make lint
```
the same as:
```bash
make check-codestyle && make test && make check-safety
```
</p>
</details>
<details>
<summary>6. Docker</summary>
<p>
```bash
make docker-build
```
which is equivalent to:
```bash
make docker-build VERSION=latest
```
Remove docker image with
```bash
make docker-remove
```
More information [about docker](https://github.com/Undertone0809/python-package-template/tree/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/docker).
</p>
</details>
<details>
<summary>7. Cleanup</summary>
<p>
Delete pycache files
```bash
make pycache-remove
```
Remove package build
```bash
make build-remove
```
Delete .DS_STORE files
```bash
make dsstore-remove
```
Remove .mypycache
```bash
make mypycache-remove
```
Or to remove all above run:
```bash
make cleanup
```
</p>
</details>
## π― What's next
Well, that's up to you πͺπ». I can only recommend the packages and articles that helped me.
- [`Typer`](https://github.com/tiangolo/typer) is great for creating CLI applications.
- [`Rich`](https://github.com/willmcgugan/rich) makes it easy to add beautiful formatting in the terminal.
- [`Pydantic`](https://github.com/samuelcolvin/pydantic/) β data validation and settings management using Python type hinting.
- [`Loguru`](https://github.com/Delgan/loguru) makes logging (stupidly) simple.
- [`tqdm`](https://github.com/tqdm/tqdm) β fast, extensible progress bar for Python and CLI.
- [`IceCream`](https://github.com/gruns/icecream) is a little library for sweet and creamy debugging.
- [`orjson`](https://github.com/ijl/orjson) β ultra fast JSON parsing library.
- [`Returns`](https://github.com/dry-python/returns) makes you function's output meaningful, typed, and safe!
- [`Hydra`](https://github.com/facebookresearch/hydra) is a framework for elegantly configuring complex applications.
- [`FastAPI`](https://github.com/tiangolo/fastapi) is a type-driven asynchronous web framework.
Articles:
- [Open Source Guides](https://opensource.guide/).
- [A handy guide to financial support for open source](https://github.com/nayafia/lemonade-stand)
- [GitHub Actions Documentation](https://help.github.com/en/actions).
- Maybe you would like to add [gitmoji](https://gitmoji.carloscuesta.me/) to commit names. This is really funny. π
## π Releases
You can see the list of available releases on the [GitHub Releases](https://github.com/Undertone0809/python-package-template/releases) page.
We follow [Semantic Versions](https://semver.org/) specification.
We use [`Release Drafter`](https://github.com/marketplace/actions/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
| **Label** | **Title in Releases** |
|:-------------------------------------:|:----------------------:|
| `enhancement`, `feature` | π Features |
| `bug`, `refactoring`, `bugfix`, `fix` | π§ Fixes & Refactoring |
| `build`, `ci`, `testing` | π¦ Build System & CI/CD |
| `breaking` | π₯ Breaking Changes |
| `documentation` | π Documentation |
| `dependencies` | β¬οΈ Dependencies updates |
## π§ͺ 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`](https://github.com/marketplace/codecov) ?).
- Auto uploading your package to [`PyPI`](https://pypi.org/) when new GitHub release is created.
- Automatic creation and deployment of documentation to GitHub pages. I look at [`MkDocs`](https://www.mkdocs.org/) with [Material Design theme](https://github.com/squidfunk/mkdocs-material) and [`mkdocstrings`](https://github.com/pawamoy/mkdocstrings).
- Code metrics with [`Radon`](https://github.com/rubik/radon).
- Docstring coverage with [`interrogate`](https://github.com/econchick/interrogate)
- `Dockerfile` linting with [`dockerfilelint`](https://github.com/replicatedhq/dockerfilelint).
- [Hall of fame](https://github.com/sourcerer-io/hall-of-fame) from `Sourcerer`.
- Some advanced Python linting (?).
- End-to-end testing and validation of the cookiecutter template.
- Add [`Earthly`](https://earthly.dev/)
## π‘ License
[](https://github.com/Undertone0809/python-package-template/blob/main/LICENSE)
This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/Undertone0809/python-package-template/blob/main/LICENSE) for more details.
## π
Acknowledgements
This template was inspired by several great articles:
- [Hypermodern Python](https://cjolowicz.github.io/posts/hypermodern-python-01-setup/)
- [Ultimate Setup for Your Next Python Project](https://martinheinz.dev/blog/14)
- [Nine simple steps for better-looking python code](https://towardsdatascience.com/nine-simple-steps-for-better-looking-python-code-87e5d9d3b1cf)
- [Modern Python developer's toolkit](https://pycon.switowski.com/)
and repositories:
- [`Cookiecutter`](https://github.com/cookiecutter/cookiecutter)
- [`wemake-python-package`](https://github.com/wemake-services/wemake-python-package)
- [Audreyr's `cookiecutter-pypackage`](https://github.com/audreyr/cookiecutter-pypackage)
- [Full Stack FastAPI and PostgreSQL - Base Project Generator](https://github.com/tiangolo/full-stack-fastapi-postgresql)
- [Cookiecutter Data Science Template: `cdst`](https://github.com/crplab/cdst)
Give them your βοΈ, these resources are amazing! π
## π Citation
```bibtex
@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 [](https://github.com/Undertone0809/python-package-template)
```markdown
[](https://github.com/Undertone0809/python-package-template)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Undertone0809/P3G",
"name": "p3g",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "python, 3pg, p3g, ruff, cookiecutter, template, packages, makefile, best-practices, poetry, codestyle, formatters, python-packages, semantic-versions",
"author": "Zeeland",
"author_email": "zeeland4work@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/08/ad/7742d43acfdf87a0ed19baecaa9da5062d63b75a0c06492f9b1022aa250a/p3g-1.3.1.tar.gz",
"platform": null,
"description": "# P3G - Python Packages Project Generator\n\n[English](README.md) [\u4e2d\u6587](README_zh.md)\n\n<div align=\"center\">\n\n[](https://github.com/Undertone0809/python-package-template/actions?query=workflow%3Abuild)\n[](https://github.com/Undertone0809/python-package-template/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)\n[](https://github.com/Undertone0809/python-package-template)\n\n[](https://github.com/psf/black)\n[](https://github.com/Undertone0809/python-package-template/blob/main/.pre-commit-config.yaml)\n[](https://github.com/Undertone0809/python-package-template/releases)\n[](https://github.com/Undertone0809/python-package-template/blob/main/LICENSE)\n\n\nYour next Python package needs a bleeding-edge project structure.\n</div>\n\n> This version is fork from [https://github.com/TezRomacH/python-package-template](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.\n\n## TL;DR\n\nIf you don't want to read the whole README, just click the `Use this template` button and start coding your Python package right now! \ud83d\ude80\n\n```bash\npip install p3g\np3g generate\n```\n\n## \ud83d\ude80 Features\n\nIn this [cookiecutter \ud83c\udf6a](https://github.com/cookiecutter/cookiecutter) template we combine state-of-the-art libraries and best development practices for Python.\n\n### Development features\n\n- Supports `Python 3.7` and higher.\n- [`Poetry`](https://python-poetry.org/) as a dependencies manager. See configuration in [`pyproject.toml`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/pyproject.toml) and [`setup.cfg`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/setup.cfg).\n- Faster formatter tool, automatic codestyle with [`ruff`](https://github.com/astral-sh/ruff) to replace [`black`](https://github.com/psf/black), [`isort`](https://github.com/timothycrosley/isort) and [`pyupgrade`](https://github.com/asottile/pyupgrade).\n- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with code-formatting.\n- Type checks with [`ruff`](https://github.com/astral-sh/ruff); docstring checks with [`darglint`](https://github.com/terrencepreilly/darglint); security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit)\n- Testing with [`pytest`](https://docs.pytest.org/en/latest/).\n- Ready-to-use [`.editorconfig`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.editorconfig), [`.dockerignore`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.dockerignore), and [`.gitignore`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.gitignore). You don't have to worry about those things.\n- The ability of building docker.\n\n### Deployment features\n\n- `GitHub` integration: issue and pr templates.\n- `Github Actions` with predefined [build workflow](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/workflows/build.yml) as the default CI/CD.\n- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with [`Makefile`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/Makefile#L89). More details in [makefile-usage](#makefile-usage).\n- [Dockerfile](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/docker/Dockerfile) for your package.\n- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/). You only need to [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates).\n- Automatic release notes with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). You may see the list of labels in [`release-drafter.yml`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.\n\n### Open source community features\n\n- Ready-to-use [Pull Requests templates](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/Undertone0809/python-package-template/tree/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/ISSUE_TEMPLATE).\n- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.\n- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/.stale.yml).\n- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).\n\n## \ud83e\udd2f How to use it\n\n### Installation\n\nTo begin using the template consider updating `p3g`\n\n```bash\npip install -U p3g\n```\n\nthen go to a directory where you want to create your project and run:\n\n```bash\np3g generate\n```\n\n### Input variables\n\nTemplate generator will ask you to fill some variables.\n\nThe input variables, with their default values:\n\n| **Parameter** | **Default value** | **Description** |\n|:---------------------:|:---------------------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `project_name` | `python-project` | [Check the availability of possible name](http://ivantomic.com/projects/ospnc/) before creating the project. |\n| `project_description` | based on the `project_name` | Brief description of your project. |\n| `organization` | based on the `project_name` | Name of the organization. We need to generate LICENCE and to specify ownership in `pyproject.toml`. |\n| `license` | `MIT` | One of `MIT`, `BSD-3`, `GNU GPL v3.0` and `Apache Software License 2.0`. |\n| `minimal_python_version` | `3.7` | Minimal Python version. One of `3.7`, `3.8` and `3.9`. It is used for builds, GitHub workflow and formatters (`black`, `isort` and `pyupgrade`). |\n| `github_name` | based on the `organization` | GitHub username for hosting. Also used to set up `README.md`, `pyproject.toml` and template files for GitHub. |\n| `email` | based on the `organization` | Email for `CODE_OF_CONDUCT.md`, `SECURITY.md` files and to specify the ownership of the project in `pyproject.toml`. |\n| `version` | `0.1.0` | Initial version of the package. Make sure it follows the [Semantic Versions](https://semver.org/) specification. |\n| `line_length` | 88 | The max length per line (used for codestyle with `black` and `isort`). NOTE: This value must be between 50 and 300. |\n| `using_tsinghua_image_source` | false | The tsinghua poetry image source |\n| `create_example_template` | `cli` | If `cli` is chosen generator will create simple CLI application with [`Typer`](https://github.com/tiangolo/typer) and [`Rich`](https://github.com/willmcgugan/rich) libraries. One of `cli`, `none` |\n\nAll input values will be saved in the `cookiecutter-config-file.yml` file so that you won't lose them. \ud83d\ude09\n\n#### Demo\n\n[](https://www.youtube.com/watch?v=dpKlGRgVp6g \"Create a cool Python project structure with p3g\")\n\n### More details\n\nYour project will contain `README.md` file with instructions for development, deployment, etc. You can read [the project README.md template](https://github.com/Undertone0809/python-package-template/tree/main/%7B%7B%20cookiecutter.project_name%20%7D%7D) before.\n\n### Initial set up\n\n#### Initialize `poetry`\n\nBy running `pip install poetry & make install`\n\nAfter you create a project, it will appear in your directory, and will display [a message about how to initialize the project](https://github.com/Undertone0809/python-package-template/tree/main/%7B%7B%20cookiecutter.project_name%20%7D%7D#very-first-steps).\n\n#### Initialize `pre-commit`\n\n`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`.\n\n### Package example\n\nWant to know more about Poetry? Check [its documentation](https://python-poetry.org/docs/).\n\n<details>\n<summary>Details about Poetry</summary>\n<p>\n\nPoetry's [commands](https://python-poetry.org/docs/cli/#commands) are very intuitive and easy to learn, like:\n\n- `poetry add numpy@latest`\n- `poetry run pytest`\n- `poetry publish --build`\n\netc\n</p>\n</details>\n\n#### CLI example\n\nIf you set `create_example_template` to be `cli` the template comes with a cute little CLI application example. It utilises [`Typer`](https://github.com/tiangolo/typer) and [`Rich`](https://github.com/willmcgugan/rich) for CLI input validation and beautiful formatting in the terminal.\n\nAfter installation via `make install` (preferred) or `poetry install` you can try to play with the example:\n\n```bash\npoetry run <project_name> --help\n```\n\n```bash\npoetry run <project_name> --name Roman\n```\n\n### Building and releasing your package\n\nBuilding a new version of the application contains steps:\n\n- 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](https://semver.org/) standard.\n- Make a commit to `GitHub`.\n- Create a `GitHub release`.\n- And... publish \ud83d\ude42 `poetry publish --build`\n\n### Makefile usage\n\n[`Makefile`](https://github.com/Undertone0809/python-package-template/blob/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/Makefile) contains a lot of functions for faster development.\n\n<details>\n<summary>1. Install all dependencies and pre-commit hooks</summary>\n<p>\n\nInstall requirements:\n\n```bash\nmake install\n```\n\nPre-commit hooks coulb be installed after `git init` via\n\n```bash\nmake pre-commit-install\n```\n\n</p>\n</details>\n\n<details>\n<summary>2. Codestyle and type checks</summary>\n<p>\n\nAutomatic formatting uses `ruff`.\n\n```bash\nmake polish-codestyle\n\n# or use synonym\nmake formatting\n```\n\nCodestyle checks only, without rewriting files:\n\n```bash\nmake check-codestyle\n```\n\n> Note: `check-codestyle` uses `ruff` and `darglint` library\n\n</p>\n</details>\n\n<details>\n<summary>3. Code security</summary>\n<p>\n\n```bash\nmake check-safety\n```\n\nThis command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.\n\n```bash\nmake check-safety\n```\n\n</p>\n</details>\n\n<details>\n<summary>4. Tests with coverage badges</summary>\n<p>\n\nRun `pytest`\n\n```bash\nmake test\n```\n\n</p>\n</details>\n\n<details>\n<summary>5. All linters</summary>\n<p>\n\nOf course there is a command to run all linters in one:\n\n```bash\nmake lint\n```\n\nthe same as:\n\n```bash\nmake check-codestyle && make test && make check-safety\n```\n\n</p>\n</details>\n\n<details>\n<summary>6. Docker</summary>\n<p>\n\n```bash\nmake docker-build\n```\n\nwhich is equivalent to:\n\n```bash\nmake docker-build VERSION=latest\n```\n\nRemove docker image with\n\n```bash\nmake docker-remove\n```\n\nMore information [about docker](https://github.com/Undertone0809/python-package-template/tree/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/docker).\n\n</p>\n</details>\n\n<details>\n<summary>7. Cleanup</summary>\n<p>\nDelete pycache files\n\n```bash\nmake pycache-remove\n```\n\nRemove package build\n\n```bash\nmake build-remove\n```\n\nDelete .DS_STORE files\n\n```bash\nmake dsstore-remove\n```\n\nRemove .mypycache\n\n```bash\nmake mypycache-remove\n```\n\nOr to remove all above run:\n\n```bash\nmake cleanup\n```\n\n</p>\n</details>\n\n## \ud83c\udfaf What's next\n\nWell, that's up to you \ud83d\udcaa\ud83c\udffb. I can only recommend the packages and articles that helped me.\n\n- [`Typer`](https://github.com/tiangolo/typer) is great for creating CLI applications.\n- [`Rich`](https://github.com/willmcgugan/rich) makes it easy to add beautiful formatting in the terminal.\n- [`Pydantic`](https://github.com/samuelcolvin/pydantic/) \u2013 data validation and settings management using Python type hinting.\n- [`Loguru`](https://github.com/Delgan/loguru) makes logging (stupidly) simple.\n- [`tqdm`](https://github.com/tqdm/tqdm) \u2013 fast, extensible progress bar for Python and CLI.\n- [`IceCream`](https://github.com/gruns/icecream) is a little library for sweet and creamy debugging.\n- [`orjson`](https://github.com/ijl/orjson) \u2013 ultra fast JSON parsing library.\n- [`Returns`](https://github.com/dry-python/returns) makes you function's output meaningful, typed, and safe!\n- [`Hydra`](https://github.com/facebookresearch/hydra) is a framework for elegantly configuring complex applications.\n- [`FastAPI`](https://github.com/tiangolo/fastapi) is a type-driven asynchronous web framework.\n\nArticles:\n\n- [Open Source Guides](https://opensource.guide/).\n- [A handy guide to financial support for open source](https://github.com/nayafia/lemonade-stand)\n- [GitHub Actions Documentation](https://help.github.com/en/actions).\n- Maybe you would like to add [gitmoji](https://gitmoji.carloscuesta.me/) to commit names. This is really funny. \ud83d\ude04\n\n## \ud83d\udcc8 Releases\n\nYou can see the list of available releases on the [GitHub Releases](https://github.com/Undertone0809/python-package-template/releases) page.\n\nWe follow [Semantic Versions](https://semver.org/) specification.\n\nWe use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you\u2019re ready. With the categories option, you can categorize pull requests in release notes using labels.\n\n### List of labels and corresponding titles\n\n| **Label** | **Title in Releases** |\n|:-------------------------------------:|:----------------------:|\n| `enhancement`, `feature` | \ud83d\ude80 Features |\n| `bug`, `refactoring`, `bugfix`, `fix` | \ud83d\udd27 Fixes & Refactoring |\n| `build`, `ci`, `testing` | \ud83d\udce6 Build System & CI/CD |\n| `breaking` | \ud83d\udca5 Breaking Changes |\n| `documentation` | \ud83d\udcdd Documentation |\n| `dependencies` | \u2b06\ufe0f Dependencies updates |\n\n## \ud83e\uddea TODOs\n\nThis template will continue to develop and follow the bleeding edge new tools and best practices to improve the Python development experience.\n\nHere is a list of things that have yet to be implemented:\n\n- Tests coverage reporting ([`Codecov`](https://github.com/marketplace/codecov) ?).\n- Auto uploading your package to [`PyPI`](https://pypi.org/) when new GitHub release is created.\n- Automatic creation and deployment of documentation to GitHub pages. I look at [`MkDocs`](https://www.mkdocs.org/) with [Material Design theme](https://github.com/squidfunk/mkdocs-material) and [`mkdocstrings`](https://github.com/pawamoy/mkdocstrings).\n- Code metrics with [`Radon`](https://github.com/rubik/radon).\n- Docstring coverage with [`interrogate`](https://github.com/econchick/interrogate)\n- `Dockerfile` linting with [`dockerfilelint`](https://github.com/replicatedhq/dockerfilelint).\n- [Hall of fame](https://github.com/sourcerer-io/hall-of-fame) from `Sourcerer`.\n- Some advanced Python linting (?).\n- End-to-end testing and validation of the cookiecutter template.\n- Add [`Earthly`](https://earthly.dev/)\n\n## \ud83d\udee1 License\n\n[](https://github.com/Undertone0809/python-package-template/blob/main/LICENSE)\n\nThis project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/Undertone0809/python-package-template/blob/main/LICENSE) for more details.\n\n## \ud83c\udfc5 Acknowledgements\n\nThis template was inspired by several great articles:\n\n- [Hypermodern Python](https://cjolowicz.github.io/posts/hypermodern-python-01-setup/)\n- [Ultimate Setup for Your Next Python Project](https://martinheinz.dev/blog/14)\n- [Nine simple steps for better-looking python code](https://towardsdatascience.com/nine-simple-steps-for-better-looking-python-code-87e5d9d3b1cf)\n- [Modern Python developer's toolkit](https://pycon.switowski.com/)\n\nand repositories:\n\n- [`Cookiecutter`](https://github.com/cookiecutter/cookiecutter)\n- [`wemake-python-package`](https://github.com/wemake-services/wemake-python-package)\n- [Audreyr's `cookiecutter-pypackage`](https://github.com/audreyr/cookiecutter-pypackage)\n- [Full Stack FastAPI and PostgreSQL - Base Project Generator](https://github.com/tiangolo/full-stack-fastapi-postgresql)\n- [Cookiecutter Data Science Template: `cdst`](https://github.com/crplab/cdst)\n\nGive them your \u2b50\ufe0f, these resources are amazing! \ud83d\ude09\n\n## \ud83d\udcc3 Citation\n\n```bibtex\n@misc{python-package-template,\n author = {Zeeland},\n title = {Python Packages Project Generator},\n year = {2023},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/Undertone0809/python-package-template}}\n}\n```\n\nMarkdown source for the badge [](https://github.com/Undertone0809/python-package-template)\n\n```markdown\n[](https://github.com/Undertone0809/python-package-template)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Packages Project Generator",
"version": "1.3.1",
"project_urls": {
"Homepage": "https://github.com/Undertone0809/P3G",
"Repository": "https://github.com/Undertone0809/P3G"
},
"split_keywords": [
"python",
" 3pg",
" p3g",
" ruff",
" cookiecutter",
" template",
" packages",
" makefile",
" best-practices",
" poetry",
" codestyle",
" formatters",
" python-packages",
" semantic-versions"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8664d206428eaa5ce95ccefe57fea9a54b41bdfd24c729cd2786e6761c5eebc2",
"md5": "c8feb2a92051d2acecb71124e114d856",
"sha256": "d758586f34f2c9aa5e56d4a9298862fbaa7fff53182c9f16819ba552ecb5bb54"
},
"downloads": -1,
"filename": "p3g-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c8feb2a92051d2acecb71124e114d856",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 8899,
"upload_time": "2024-05-18T21:52:45",
"upload_time_iso_8601": "2024-05-18T21:52:45.511844Z",
"url": "https://files.pythonhosted.org/packages/86/64/d206428eaa5ce95ccefe57fea9a54b41bdfd24c729cd2786e6761c5eebc2/p3g-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "08ad7742d43acfdf87a0ed19baecaa9da5062d63b75a0c06492f9b1022aa250a",
"md5": "e1ce4ed923b90dcbc295b46080a30274",
"sha256": "e153f51ab91bbbde47fbc680b47eacd355ef4f1e1ae87ad1b81aeaa9d435d007"
},
"downloads": -1,
"filename": "p3g-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "e1ce4ed923b90dcbc295b46080a30274",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 9594,
"upload_time": "2024-05-18T21:52:47",
"upload_time_iso_8601": "2024-05-18T21:52:47.191412Z",
"url": "https://files.pythonhosted.org/packages/08/ad/7742d43acfdf87a0ed19baecaa9da5062d63b75a0c06492f9b1022aa250a/p3g-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-18 21:52:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Undertone0809",
"github_project": "P3G",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "arrow",
"specs": [
[
"==",
"1.2.3"
]
]
},
{
"name": "binaryornot",
"specs": [
[
"==",
"0.4.4"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2023.7.22"
]
]
},
{
"name": "chardet",
"specs": [
[
"==",
"5.2.0"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.3.2"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "cookiecutter",
"specs": [
[
"==",
"1.7.3"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.4"
]
]
},
{
"name": "importlib-metadata",
"specs": [
[
"==",
"4.13.0"
]
]
},
{
"name": "jinja2-time",
"specs": [
[
"==",
"0.2.0"
]
]
},
{
"name": "jinja2",
"specs": [
[
"==",
"3.1.2"
]
]
},
{
"name": "markupsafe",
"specs": [
[
"==",
"2.1.3"
]
]
},
{
"name": "poyo",
"specs": [
[
"==",
"0.5.0"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.8.2"
]
]
},
{
"name": "python-slugify",
"specs": [
[
"==",
"8.0.1"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "text-unidecode",
"specs": [
[
"==",
"1.3"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
"==",
"4.7.1"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.0.7"
]
]
},
{
"name": "zipp",
"specs": [
[
"==",
"3.15.0"
]
]
}
],
"lcname": "p3g"
}
JSON
