Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tedivm/robs_awesome_python_template
A Highly Configurable Python Project Template for Modern Python Projects
https://github.com/tedivm/robs_awesome_python_template
List: robs_awesome_python_template
cookiecutter-python cookiecutter-template python
Last synced: about 2 months ago
JSON representation
A Highly Configurable Python Project Template for Modern Python Projects
- Host: GitHub
- URL: https://github.com/tedivm/robs_awesome_python_template
- Owner: tedivm
- License: mit
- Created: 2022-12-11T00:51:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T13:15:06.000Z (5 months ago)
- Last Synced: 2024-05-22T15:05:24.452Z (4 months ago)
- Topics: cookiecutter-python, cookiecutter-template, python
- Language: Python
- Homepage: https://blog.tedivm.com/open-source/2023/02/robs-awesome-python-template/
- Size: 89.8 KB
- Stars: 116
- Watchers: 5
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - tedivm/robs_awesome_python_template - A Highly Configurable Python Project Template for Modern Python Projects (Python)
README
# Rob's Awesome Python Template
Rob's Awesome Python Template is extremely customizable- it can work for the smallest library to the largest application.
- [Rob's Awesome Python Template](#robs-awesome-python-template)
- [Usage](#usage)
- [Core Functionality](#core-functionality)
- [Optional Libraries](#optional-libraries)
- [FastAPI](#fastapi)
- [Celery](#celery)
- [QuasiQueue](#quasiqueue)
- [Typer and Click](#typer-and-click)
- [SQLAlchemy and Alembic](#sqlalchemy-and-alembic)
- [Paracelsus](#paracelsus)
- [Docker](#docker)
- [Github Actions](#github-actions)
- [Examples](#examples)
## Usage
1. Install `cookiecutter`.
2. Install `pyenv` if you haven't already.
3. Run the cookiecutter command.
```bash
cookiecutter gh:tedivm/robs_awesome_python_template
```
The rest of the process is interactive- you'll be asked for a project name and about which features you want enabled, after which the project will be setup.
## Core Functionality
- Development Management using [Makefiles](https://www.gnu.org/software/make/manual/html_node/Introduction.html).
- Configuration Management with [Pydantic Settings]([https://docs.pydantic.dev/usage/settings/](https://docs.pydantic.dev/latest/concepts/pydantic_settings/)).
- PyPI Publishing from Github Tags using [setuptools-scm](https://pypi.org/project/setuptools-scm/).
- Formatting and Linting with [Ruff](https://docs.astral.sh/ruff/).
- Typing with [mypy](https://mypy.readthedocs.io/en/stable/).
- Lockfiles (requirements.txt) with [uv](https://pypi.org/project/uv/).
- Testing with [pytest](https://docs.pytest.org/en/7.2.x/).
- CI/CD using [Github Actions](https://docs.github.com/en/actions).
- Precommit Hooks using the [precommit framework](https://pre-commit.com/).
- Multiple license options.
- Modern `pyproject.toml` without any legacy files.
## Optional Libraries
This template can also configure and setup a variety of optional services. Each optional service adds its own dependencies, configuration, handlers, and everything else needed to jump right into development.
Features that are not selected get completely cleaned up and will not pollute the newly created project.
### FastAPI
[FastAPI](https://fastapi.tiangolo.com/) is one of the easiest ways to develop REST Based APIs. When enabled a "Hello World" application will be setup.
### Celery
[Celery](https://docs.celeryq.dev/en/stable/getting-started/introduction.html) is the standard for Queue Management systems with Python.
### QuasiQueue
[QuasiQueue](https://github.com/tedivm/quasiqueue) is a high performance multiprocessing library that is also very simple to use.
### Typer and Click
[Typer](https://typer.tiangolo.com/typer-cli/), which is built on top of the [Click Framework](https://click.palletsprojects.com), is one of the easiest ways to build command line applications. When enabled this template will create an initial CLI handler and register it with python for easy installation.
### SQLAlchemy and Alembic
[SQLAlchemy](https://www.sqlalchemy.org/) is one of the most used SQL ORM frameworks in python. It is regularly paired with [Alembic](https://alembic.sqlalchemy.org/en/latest/) to handle database migrations.
This template configures SQLAlchemy and Alembic to work together using a unified configuration. Alembic will automatically discover all models in the `models` directory.
Projects with this template will have access to the Async SQLAlchemy engine.
### Paracelsus
[Paracelsus](https://github.com/tedivm/paracelsus) is a library that automatically generates diagrams of SQLAlchemy database schemas and injects them into documentation.
### Docker
Docker Images are the standard for distributing and running applications. The Docker extensions to this project create containers for the other services that are enabled, such as FastAPI and Celery.
The images made by this template come from the [Multi-Py](https://github.com/multi-py/) project and support both AMD and ARM architectures.
### Github Actions
Github Action Workflows are optionally created for a variety of tasks-
- Formatting Python, JSON, YAML, and TOML
- Testing
- Typing
- Publishing Packages to PyPI
- Pushing Images to GHCR
- Updating Dependency (requirements.txt) Files
- Updating Documentation
## Examples
Project examples are available in the [example repository](https://github.com/tedivm/robs_awesome_python_template_examples).
- [Basic Library](https://github.com/tedivm/robs_awesome_python_template_examples/tree/main/library)- enables basic library features without the full scale applications.
- [All Options Enabled](https://github.com/tedivm/robs_awesome_python_template_examples/tree/main/full)- includes every option and service.
- [All Options Disabled](https://github.com/tedivm/robs_awesome_python_template_examples/tree/main/bare)- disabled every optional service for an extremely basic scaffold.
These are just some options, as features can be mixed and matched to create numerous permutations.