| Name | oe-python-template JSON |
| Version |
0.12.15
JSON |
| download |
| home_page | None |
| Summary | 🧠Copier template to scaffold Python projects compliant with best practices and modern tooling. |
| upload_time | 2025-04-21 00:03:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.11 |
| license | MIT License Copyright (c) [2025] [Helmut Hoffer von Ankershoffen (helmuthva@gmail.com)] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
act
codecov
copier
cyclonedx
detect-secrets
devcontainer
docker
git-cliff
jupyter
marimo
mypy
nox
oe-python-template
pip-audit
pip-licenses
pre-commit
pydantic
pypi
pytest
python
readthedocs
ruff
sonarcloud
sonarqube
sphinx
streamlit
typer
uv
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[//]: # (README.md generated from docs/partials/README_*.md)
# 🧠OE Python Template
[
](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/LICENSE)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml)
[](https://oe-python-template.readthedocs.io/en/latest/)
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/code-scanning)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/dependabot)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard)
[](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commits/main/)
[](https://pypi.python.org/pypi/oe-python-template)
[](https://pypi.python.org/pypi/oe-python-template)
[](https://hub.docker.com/r/helmuthva/oe-python-template/tags)
[](https://hub.docker.com/r/helmuthva/oe-python-template/)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
[](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template)
[](https://oe-python-template.vercel.app/api/v1/hello/world)
[](https://helmut-hoffer-von-ankershoffen.betteruptime.com/)
<!---
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/pkgs/container/oe-python-template)
[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/pkgs/container/oe-python-template)
-->
> [!TIP]
> 📚 [Online documentation](https://oe-python-template.readthedocs.io/en/latest/) - 📖 [PDF Manual](https://oe-python-template.readthedocs.io/_/downloads/en/latest/pdf/)
---
Copier template to scaffold Python projects compliant with best practices and modern tooling.
### Scaffolding
This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate (scaffold) a Python package with fully functioning build and test automation:
1. Projects generated from this template can be [easily updated](https://copier.readthedocs.io/en/stable/updating/) to benefit from improvements and new features of the template.
2. During project generation, you can flexibly configure naming of the Python distribution, import package, main author, GitHub repository, organization, and many other aspects to match your specific requirements (see [copier.yml](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/copier.yml) for all available options).
### Development Infrastructure
Projects generated with this template come with a comprehensive development toolchain and quality assurance framework that supports the entire software development lifecycle - from coding and testing to documentation, release management, and compliance auditing. This infrastructure automates routine tasks, enforces code quality standards, and streamlines the path to production:
1. Linting with [Ruff](https://github.com/astral-sh/ruff)
2. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
3. Complete set of [pre-commit](https://pre-commit.com/) hooks including [detect-secrets](https://github.com/Yelp/detect-secrets) and [pygrep](https://github.com/pre-commit/pygrep-hooks)
4. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
5. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
6. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
8. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
9. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
10. Dependency monitoring and vulnerability scanning with [pip-audit](https://pypi.org/project/pip-audit/), [trivy](https://trivy.dev/latest/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
11. Error monitoring and profiling with [Sentry](https://sentry.io/) (optional)
12. Logging and metrics with [Logfire](https://logfire.dev/) (optional)
13. Prepared for uptime monitoring with [betterstack](https://betterstack.com/) or alternatives
13. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/), matched with allow list, and published as release artifacts in CSV and JSON format for further compliance checks
14. Generation of attributions from extracted licenses
15. Software Bill of Materials (SBOM) generated in [CycloneDX](https://cyclonedx.org/) and [SPDX](https://spdx.dev/) formats with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) resp. [trivy](https://trivy.dev/latest/), published as release artifacts
16. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
17. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
18. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
19. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
20. Documentation including dynamic badges, setup instructions, contribution guide and security policy
21. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
22. Python package published to [PyPI](https://pypi.org/)
23. Multi-stage build of fat and slim (no-extras) Docker images, app running nonroot
24. Mult-arch Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
25. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
26. Settings for use with [VSCode](https://code.visualstudio.com/)
27. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
28. API deployed as serverless function to [Vercel](https://vercel.com/) (optional)
### Application Features
Beyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning application and service. This reference implementation serves as a starting point for your own business logic with modern patterns and enterprise practices already in place:
1. Usable as library with "Hello" module exposing a simple service that can say "Hello, world!" and echo utterances.
2. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
2. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)
3. Comfortable command-line interface (CLI) with
[Typer](https://typer.tiangolo.com/)
4. Cross-platform Graphical User Interface (GUI) with
[NiceGUI](https://nicegui.io/) running in native window
5. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
6. Simple Web UI with [Streamlit](https://streamlit.io/)
7. Validation and settings management with [pydantic](https://docs.pydantic.dev/)
8. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/)
9. Modular architecture including auto-registration of services, CLI commands, API routes and GUI pages exposed by domain modules
10. System module providing aggregate health and info to the runtime, compiled settings, and further info provided by domain modules
11. Health and Info available via command, webservice API (info passsword protected) and GUI
12. Hello service demonstrates use of custom real time metrics collected via Logfire
13. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)
Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
## Generate a new project
To generate, build and release a fully functioning project in a few minutes, follow these 5 steps:
**Step 1**: Execute the following command to install or update tooling.
```shell
# Install Homebrew, uv package manager, copier and further dev tools
curl -LsSf https://raw.githubusercontent.com/helmut-hoffer-von-ankershoffen/oe-python-template/HEAD/install.sh | sh
```
**Step 2**: [Create a repository on GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository), clone to your local machine, and change into it's directory.
**Step 3**: Execute the following command to generate a new project based on this template.
```shell
# Ensure to stand in your freshly created git repository before executing this command
copier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .
```
**Step 4**: Execute the following commands to push your initial commit to GitHub.
```shell
git add .
git commit -m "chore: Initial commit"
git push
```
Check the [Actions tab](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions) of your GitHub repository: The CI/CD workflow of your project is already running!
The workflow will fail at the SonarQube step, as this external service is not yet configured for our new repository. We will configure SonarQube and other services in the next step!
Notes:
1. Check out [this manual](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key) on how to set up signed commits
**Step 5**: Follow the [instructions](SERVICE_CONNECTIONS.md) to wire up
external services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, and Streamlit Community Cloud.
**Step 6**: Release the first version of your project
```shell
make bump
```
Notes:
1. You can remove the above sections - from "Scaffolding" to this notes - post having successfully generated your project.
2. The following sections refer to the dummy application and service generated into the `tests` and `src` folder by this template.
Use the documentation and code as inspiration, adapt to your business logic, or remove and start documenting and coding from scratch.
## Overview
Adding OE Python Template to your project as a dependency is easy. See below for usage examples.
```shell
uv add oe-python-template # add dependency to your project
```
If you don't have uv installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/). If you still prefer pip over the modern and fast package manager [uv](https://github.com/astral-sh/uv), you can install the library like this:
```shell
pip install oe-python-template # add dependency to your project
```
Executing the command line interface (CLI) in an isolated Python environment is just as easy:
```shell
uvx oe-python-template hello world # prints "Hello, world! [..]"
uvx oe-python-template hello echo "Lorem Ipsum" # echos "Lorem Ipsum"
uvx oe-python-template gui # opens the graphical user interface (GUI)
uvx oe-python-template system serve # serves web API
uvx oe-python-template system serve --port=4711 # serves web API on port 4711
uvx oe-python-template system openapi # serves web API on port 4711
```
Notes:
1. The API is versioned, mounted at `/api/v1` resp. `/api/v2`
2. While serving the web API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the `hello-world` operation.
3. Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
The CLI provides extensive help:
```shell
uvx oe-python-template --help # all CLI commands
uvx oe-python-template hello world --help # help for specific command
uvx oe-python-template hello echo --help
uvx oe-python-template gui --help
uvx oe-python-template system serve --help
uvx oe-python-template system openapi --help
```
## Operational Excellence
This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
1. Various examples demonstrating usage:
a. [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
b. [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
c. [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py) notebook
2. Complete reference documentation [for the library](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html), [for the CLI](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) and [for the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) on Read the Docs
3. [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
4. Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
5. Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
6. Up-to-date dependencies (monitored by [Renovate](https://github.com/renovatebot/renovate) and [Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/dependabot))
7. [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template) in security, maintainability, and reliability with low technical debt and codesmell (verified by SonarQube)
8. Additional code security checks using [CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/code-scanning)
9. [Security Policy](SECURITY.md)
10. [License](LICENSE) compliant with the Open Source Initiative (OSI)
11. 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/oe-python-template/tags)
12. Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
## Usage Examples
The following examples run from source - clone this repository using
`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git`.
### Minimal Python Script:
```python
"""Example script demonstrating the usage of the service provided by OE Python Template."""
from dotenv import load_dotenv
from rich.console import Console
from oe_python_template.hello import Service
console = Console()
load_dotenv()
message = Service.get_hello_world()
console.print(f"[blue]{message}[/blue]")
```
[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html)
### Streamlit App
Serve the functionality provided by OE Python Template in the web by easily integrating the service into a Streamlit application.
[Try it out!](https://oe-python-template.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/streamlit.py)
... or serve the app locally
```shell
uv sync --all-extras # Install streamlit dependency part of the examples extra, see pyproject.toml
uv run streamlit run examples/streamlit.py # Serve on localhost:8501, opens browser
```
### Vercel Serverless Function
Serve the API as a [serverless function on Vercel](https://oe-python-template.vercel.app/)
## Notebooks
### Jupyter
[Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb)
... or run within VSCode
```shell
uv sync --all-extras # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
```
Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
Click on `examples/notebook.ipynb` in VSCode and run it.
### Marimo
[Show the marimo code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py)
Execute the notebook as a WASM based web app
```shell
uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
uv run marimo run examples/notebook.py --watch # Serve on localhost:2718, opens browser
```
or edit interactively in your browser
```shell
uv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml
uv run marimo edit examples/notebook.py --watch # Edit on localhost:2718, opens browser
```
... or edit interactively within VSCode
Install the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)
Click on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > "Start in marimo editor" (edit).
## Command Line Interface (CLI)
### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)
Show available commands:
```shell
uvx oe-python-template --help
```
Execute commands:
```shell
uvx oe-python-template hello world
uvx oe-python-template hello echo --help
uvx oe-python-template hello echo "Lorem"
uvx oe-python-template hello echo "Lorem" --json
uvx oe-python-template gui
uvx oe-python-template system info
uvx oe-python-template system health
uvx oe-python-template system openapi
uvx oe-python-template system openapi --output-format=json
uvx oe-python-template system serve
```
See the [reference documentation of the CLI](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) for detailed documentation of all CLI commands and options.
### Environment
The service loads environment variables including support for .env files.
```shell
cp .env.example .env # copy example file
echo "THE_VAR=MY_VALUE" > .env # overwrite with your values
```
Now run the usage examples again.
### Run with Docker
You can as well run the CLI within Docker.
```shell
docker run helmuthva/oe-python-template --help
docker run helmuthva/oe-python-template hello world
docker run helmuthva/oe-python-template hello echo --help
docker run helmuthva/oe-python-template hello echo "Lorem"
docker run helmuthva/oe-python-template hello echo "Lorem" --json
docker run helmuthva/oe-python-template system info
docker run helmuthva/oe-python-template system health
docker run helmuthva/oe-python-template system openapi
docker run helmuthva/oe-python-template system openapi --output-format=json
docker run helmuthva/oe-python-template system serve
```
Execute command:
```shell
docker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template hello echo "Lorem Ipsum"
```
Or use docker compose
The .env is passed through from the host to the Docker container.
```shell
docker compose run --remove-orphans oe-python-template --help
docker compose run --remove-orphans oe-python-template hello world
docker compose run --remove-orphans oe-python-template hello echo --help
docker compose run --remove-orphans oe-python-template hello echo "Lorem"
docker compose run --remove-orphans oe-python-template hello echo "Lorem" --json
docker compose run --remove-orphans oe-python-template system info
docker compose run --remove-orphans oe-python-template system health
docker compose run --remove-orphans oe-python-template system openapi
docker compose run --remove-orphans oe-python-template system openapi --output-format=json
echo "Running OE Python Template's API container as a daemon ..."
docker compose up -d
echo "Waiting for the API server to start ..."
sleep 5
echo "Checking health of v1 API ..."
curl http://127.0.0.1:8000/api/v1/healthz
echo ""
echo "Saying hello world with v1 API ..."
curl http://127.0.0.1:8000/api/v1/hello/world
echo ""
echo "Swagger docs of v1 API ..."
curl http://127.0.0.1:8000/api/v1/docs
echo ""
echo "Checking health of v2 API ..."
curl http://127.0.0.1:8000/api/v2/healthz
echo ""
echo "Saying hello world with v1 API ..."
curl http://127.0.0.1:8000/api/v2/hello/world
echo ""
echo "Swagger docs of v2 API ..."
curl http://127.0.0.1:8000/api/v2/docs
echo ""
echo "Shutting down the API container ..."
docker compose down
```
#### Slim
The default Docker image includes all extras. Additionally a slim image is provided, with no extras. Run as follows
```shell
docker compose run --remove-orphans oe-python-template-slim --help
```
* See the [reference documentation of the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) for detailed documentation of all API operations and parameters.
## Extra: Lorem Ipsum
Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.
## Further Reading
* Inspect our [security policy](https://oe-python-template.readthedocs.io/en/latest/security.html) with detailed documentation of checks, tools and principles.
* Check out the [CLI reference](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) with detailed documentation of all CLI commands and options.
* Check out the [library reference](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html) with detailed documentation of public classes and functions.
* Check out the [API reference](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
* Our [release notes](https://oe-python-template.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
* In case you want to help us improve 🧠OE Python Template: The [contribution guidelines](https://oe-python-template.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
* We gratefully acknowledge the [open source projects](https://oe-python-template.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!
## Star History
<a href="https://star-history.com/#helmut-hoffer-von-ankershoffen/oe-python-template">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template&type=Date" />
</picture>
</a>
Raw data
{
"_id": null,
"home_page": null,
"name": "oe-python-template",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "act, codecov, copier, cyclonedx, detect-secrets, devcontainer, docker, git-cliff, jupyter, marimo, mypy, nox, oe-python-template, pip-audit, pip-licenses, pre-commit, pydantic, pypi, pytest, python, readthedocs, ruff, sonarcloud, sonarqube, sphinx, streamlit, typer, uv",
"author": null,
"author_email": "Helmut Hoffer von Ankershoffen <helmuthva@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8a/2d/a49d68b27a4624e471edcb4f8c1aec7365fbc0e11592bee3e16406d5194b/oe_python_template-0.12.15.tar.gz",
"platform": null,
"description": "\n[//]: # (README.md generated from docs/partials/README_*.md)\n\n# \ud83e\udde0 OE Python Template\n\n[\n](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/LICENSE)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/test-and-report.yml)\n[](https://oe-python-template.readthedocs.io/en/latest/)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)\n[](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/code-scanning)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/dependabot)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard)\n[](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commits/main/)\n[](https://pypi.python.org/pypi/oe-python-template)\n[](https://pypi.python.org/pypi/oe-python-template)\n[](https://hub.docker.com/r/helmuthva/oe-python-template/tags)\n[](https://hub.docker.com/r/helmuthva/oe-python-template/)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)\n[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)\n[](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template)\n[](https://oe-python-template.vercel.app/api/v1/hello/world)\n[](https://helmut-hoffer-von-ankershoffen.betteruptime.com/)\n\n<!---\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/pkgs/container/oe-python-template)\n[](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/pkgs/container/oe-python-template)\n-->\n\n> [!TIP]\n> \ud83d\udcda [Online documentation](https://oe-python-template.readthedocs.io/en/latest/) - \ud83d\udcd6 [PDF Manual](https://oe-python-template.readthedocs.io/_/downloads/en/latest/pdf/)\n\n---\n\n\nCopier template to scaffold Python projects compliant with best practices and modern tooling.\n\n### Scaffolding\n\nThis [Copier](https://copier.readthedocs.io/en/stable/) template enables you to quickly generate (scaffold) a Python package with fully functioning build and test automation:\n\n1. Projects generated from this template can be [easily updated](https://copier.readthedocs.io/en/stable/updating/) to benefit from improvements and new features of the template.\n2. During project generation, you can flexibly configure naming of the Python distribution, import package, main author, GitHub repository, organization, and many other aspects to match your specific requirements (see [copier.yml](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/copier.yml) for all available options).\n\n### Development Infrastructure\n\nProjects generated with this template come with a comprehensive development toolchain and quality assurance framework that supports the entire software development lifecycle - from coding and testing to documentation, release management, and compliance auditing. This infrastructure automates routine tasks, enforces code quality standards, and streamlines the path to production:\n\n1. Linting with [Ruff](https://github.com/astral-sh/ruff)\n2. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)\n3. Complete set of [pre-commit](https://pre-commit.com/) hooks including [detect-secrets](https://github.com/Yelp/detect-secrets) and [pygrep](https://github.com/pre-commit/pygrep-hooks)\n4. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution\n5. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)\n6. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact\n7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)\n8. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)\n9. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)\n10. Dependency monitoring and vulnerability scanning with [pip-audit](https://pypi.org/project/pip-audit/), [trivy](https://trivy.dev/latest/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)\n11. Error monitoring and profiling with [Sentry](https://sentry.io/) (optional)\n12. Logging and metrics with [Logfire](https://logfire.dev/) (optional)\n13. Prepared for uptime monitoring with [betterstack](https://betterstack.com/) or alternatives\n13. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/), matched with allow list, and published as release artifacts in CSV and JSON format for further compliance checks\n14. Generation of attributions from extracted licenses\n15. Software Bill of Materials (SBOM) generated in [CycloneDX](https://cyclonedx.org/) and [SPDX](https://spdx.dev/) formats with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) resp. [trivy](https://trivy.dev/latest/), published as release artifacts\n16. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)\n17. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)\n18. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API\n19. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions\n20. Documentation including dynamic badges, setup instructions, contribution guide and security policy\n21. Interactive OpenAPI specification with [Swagger](https://swagger.io/)\n22. Python package published to [PyPI](https://pypi.org/)\n23. Multi-stage build of fat and slim (no-extras) Docker images, app running nonroot\n24. Mult-arch Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)\n25. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)\n26. Settings for use with [VSCode](https://code.visualstudio.com/)\n27. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)\n28. API deployed as serverless function to [Vercel](https://vercel.com/) (optional)\n\n### Application Features\n\nBeyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning application and service. This reference implementation serves as a starting point for your own business logic with modern patterns and enterprise practices already in place:\n\n1. Usable as library with \"Hello\" module exposing a simple service that can say \"Hello, world!\" and echo utterances.\n2. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)\n2. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)\n3. Comfortable command-line interface (CLI) with\n [Typer](https://typer.tiangolo.com/)\n4. Cross-platform Graphical User Interface (GUI) with\n [NiceGUI](https://nicegui.io/) running in native window\n5. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)\n6. Simple Web UI with [Streamlit](https://streamlit.io/)\n7. Validation and settings management with [pydantic](https://docs.pydantic.dev/)\n8. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/) \n9. Modular architecture including auto-registration of services, CLI commands, API routes and GUI pages exposed by domain modules\n10. System module providing aggregate health and info to the runtime, compiled settings, and further info provided by domain modules\n11. Health and Info available via command, webservice API (info passsword protected) and GUI\n12. Hello service demonstrates use of custom real time metrics collected via Logfire\n13. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)\n\nExplore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.\n\n## Generate a new project\n\nTo generate, build and release a fully functioning project in a few minutes, follow these 5 steps:\n\n**Step 1**: Execute the following command to install or update tooling.\n```shell\n# Install Homebrew, uv package manager, copier and further dev tools\ncurl -LsSf https://raw.githubusercontent.com/helmut-hoffer-von-ankershoffen/oe-python-template/HEAD/install.sh | sh\n```\n\n**Step 2**: [Create a repository on GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository), clone to your local machine, and change into it's directory.\n\n**Step 3**: Execute the following command to generate a new project based on this template.\n```shell\n# Ensure to stand in your freshly created git repository before executing this command\ncopier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .\n```\n\n**Step 4**: Execute the following commands to push your initial commit to GitHub.\n```shell\ngit add .\ngit commit -m \"chore: Initial commit\"\ngit push\n```\n\nCheck the [Actions tab](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions) of your GitHub repository: The CI/CD workflow of your project is already running!\n\nThe workflow will fail at the SonarQube step, as this external service is not yet configured for our new repository. We will configure SonarQube and other services in the next step!\n\nNotes:\n1. Check out [this manual](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key) on how to set up signed commits\n\n**Step 5**: Follow the [instructions](SERVICE_CONNECTIONS.md) to wire up\nexternal services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, and Streamlit Community Cloud.\n\n**Step 6**: Release the first version of your project\n```shell\nmake bump\n```\nNotes:\n1. You can remove the above sections - from \"Scaffolding\" to this notes - post having successfully generated your project.\n2. The following sections refer to the dummy application and service generated into the `tests` and `src` folder by this template.\n Use the documentation and code as inspiration, adapt to your business logic, or remove and start documenting and coding from scratch.\n\n\n## Overview\n\nAdding OE Python Template to your project as a dependency is easy. See below for usage examples.\n\n```shell\nuv add oe-python-template # add dependency to your project\n```\n\nIf you don't have uv installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/). If you still prefer pip over the modern and fast package manager [uv](https://github.com/astral-sh/uv), you can install the library like this:\n\n\n```shell\npip install oe-python-template # add dependency to your project\n```\n\nExecuting the command line interface (CLI) in an isolated Python environment is just as easy:\n\n```shell\nuvx oe-python-template hello world # prints \"Hello, world! [..]\"\nuvx oe-python-template hello echo \"Lorem Ipsum\" # echos \"Lorem Ipsum\"\nuvx oe-python-template gui # opens the graphical user interface (GUI)\nuvx oe-python-template system serve # serves web API\nuvx oe-python-template system serve --port=4711 # serves web API on port 4711\nuvx oe-python-template system openapi # serves web API on port 4711\n```\n\nNotes:\n1. The API is versioned, mounted at `/api/v1` resp. `/api/v2`\n2. While serving the web API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the `hello-world` operation.\n3. Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)\n\n\nThe CLI provides extensive help:\n\n```shell\nuvx oe-python-template --help # all CLI commands\nuvx oe-python-template hello world --help # help for specific command\nuvx oe-python-template hello echo --help\nuvx oe-python-template gui --help\nuvx oe-python-template system serve --help\nuvx oe-python-template system openapi --help\n```\n\n\n## Operational Excellence\n\nThis project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:\n\n1. Various examples demonstrating usage:\n a. [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)\n b. [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)\n c. [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py) notebook\n2. Complete reference documentation [for the library](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html), [for the CLI](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) and [for the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) on Read the Docs\n3. [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)\n4. Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))\n5. Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))\n6. Up-to-date dependencies (monitored by [Renovate](https://github.com/renovatebot/renovate) and [Dependabot](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/dependabot))\n7. [A-grade code quality](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template) in security, maintainability, and reliability with low technical debt and codesmell (verified by SonarQube)\n8. Additional code security checks using [CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/code-scanning)\n9. [Security Policy](SECURITY.md)\n10. [License](LICENSE) compliant with the Open Source Initiative (OSI)\n11. 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/oe-python-template/tags)\n12. Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)\n\n\n## Usage Examples\n\nThe following examples run from source - clone this repository using\n`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git`.\n\n### Minimal Python Script:\n\n```python\n\"\"\"Example script demonstrating the usage of the service provided by OE Python Template.\"\"\"\n\nfrom dotenv import load_dotenv\nfrom rich.console import Console\n\nfrom oe_python_template.hello import Service\n\nconsole = Console()\n\nload_dotenv()\n\nmessage = Service.get_hello_world()\nconsole.print(f\"[blue]{message}[/blue]\")\n```\n\n[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html)\n\n\n### Streamlit App\n\nServe the functionality provided by OE Python Template in the web by easily integrating the service into a Streamlit application.\n\n[Try it out!](https://oe-python-template.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/streamlit.py)\n\n... or serve the app locally\n```shell\nuv sync --all-extras # Install streamlit dependency part of the examples extra, see pyproject.toml\nuv run streamlit run examples/streamlit.py # Serve on localhost:8501, opens browser\n```\n\n### Vercel Serverless Function\n\nServe the API as a [serverless function on Vercel](https://oe-python-template.vercel.app/)\n\n\n## Notebooks\n\n### Jupyter\n\n[Show the Jupyter code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.ipynb)\n\n... or run within VSCode\n\n```shell\nuv sync --all-extras # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml\n```\nInstall the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)\n\nClick on `examples/notebook.ipynb` in VSCode and run it.\n\n### Marimo\n\n[Show the marimo code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/notebook.py)\n\nExecute the notebook as a WASM based web app\n\n```shell\nuv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml\nuv run marimo run examples/notebook.py --watch # Serve on localhost:2718, opens browser\n```\n\nor edit interactively in your browser\n\n```shell\nuv sync --all-extras # Install ipykernel dependency part of the examples extra, see pyproject.toml\nuv run marimo edit examples/notebook.py --watch # Edit on localhost:2718, opens browser\n```\n\n... or edit interactively within VSCode\n\nInstall the [Marimo extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marimo-team.vscode-marimo)\n\nClick on `examples/notebook.py` in VSCode and click on the caret next to the Run icon above the code (looks like a pencil) > \"Start in marimo editor\" (edit).\n\n## Command Line Interface (CLI)\n\n### Run with [uvx](https://docs.astral.sh/uv/guides/tools/)\n\nShow available commands:\n\n```shell\nuvx oe-python-template --help\n```\n\nExecute commands:\n\n```shell\nuvx oe-python-template hello world\nuvx oe-python-template hello echo --help\nuvx oe-python-template hello echo \"Lorem\"\nuvx oe-python-template hello echo \"Lorem\" --json\nuvx oe-python-template gui\nuvx oe-python-template system info\nuvx oe-python-template system health\nuvx oe-python-template system openapi\nuvx oe-python-template system openapi --output-format=json\nuvx oe-python-template system serve\n```\n\nSee the [reference documentation of the CLI](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) for detailed documentation of all CLI commands and options.\n\n\n### Environment\n\nThe service loads environment variables including support for .env files.\n\n```shell\ncp .env.example .env # copy example file\necho \"THE_VAR=MY_VALUE\" > .env # overwrite with your values\n```\n\nNow run the usage examples again.\n\n### Run with Docker\n\nYou can as well run the CLI within Docker.\n\n```shell\ndocker run helmuthva/oe-python-template --help\ndocker run helmuthva/oe-python-template hello world\ndocker run helmuthva/oe-python-template hello echo --help\ndocker run helmuthva/oe-python-template hello echo \"Lorem\"\ndocker run helmuthva/oe-python-template hello echo \"Lorem\" --json\ndocker run helmuthva/oe-python-template system info\ndocker run helmuthva/oe-python-template system health\ndocker run helmuthva/oe-python-template system openapi\ndocker run helmuthva/oe-python-template system openapi --output-format=json\ndocker run helmuthva/oe-python-template system serve\n```\n\nExecute command:\n\n```shell\ndocker run --env THE_VAR=MY_VALUE helmuthva/oe-python-template hello echo \"Lorem Ipsum\"\n```\n\nOr use docker compose\n\nThe .env is passed through from the host to the Docker container.\n\n```shell\ndocker compose run --remove-orphans oe-python-template --help\ndocker compose run --remove-orphans oe-python-template hello world\ndocker compose run --remove-orphans oe-python-template hello echo --help\ndocker compose run --remove-orphans oe-python-template hello echo \"Lorem\"\ndocker compose run --remove-orphans oe-python-template hello echo \"Lorem\" --json\ndocker compose run --remove-orphans oe-python-template system info\ndocker compose run --remove-orphans oe-python-template system health\ndocker compose run --remove-orphans oe-python-template system openapi\ndocker compose run --remove-orphans oe-python-template system openapi --output-format=json\necho \"Running OE Python Template's API container as a daemon ...\"\ndocker compose up -d\necho \"Waiting for the API server to start ...\"\nsleep 5\necho \"Checking health of v1 API ...\"\ncurl http://127.0.0.1:8000/api/v1/healthz\necho \"\"\necho \"Saying hello world with v1 API ...\"\ncurl http://127.0.0.1:8000/api/v1/hello/world\necho \"\"\necho \"Swagger docs of v1 API ...\"\ncurl http://127.0.0.1:8000/api/v1/docs\necho \"\"\necho \"Checking health of v2 API ...\"\ncurl http://127.0.0.1:8000/api/v2/healthz\necho \"\"\necho \"Saying hello world with v1 API ...\"\ncurl http://127.0.0.1:8000/api/v2/hello/world\necho \"\"\necho \"Swagger docs of v2 API ...\"\ncurl http://127.0.0.1:8000/api/v2/docs\necho \"\"\necho \"Shutting down the API container ...\"\ndocker compose down\n```\n\n#### Slim\n\nThe default Docker image includes all extras. Additionally a slim image is provided, with no extras. Run as follows\n\n```shell\ndocker compose run --remove-orphans oe-python-template-slim --help\n```\n\n\n* See the [reference documentation of the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) for detailed documentation of all API operations and parameters.\n\n\n## Extra: Lorem Ipsum\n\nDolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.\n\n\n## Further Reading\n\n* Inspect our [security policy](https://oe-python-template.readthedocs.io/en/latest/security.html) with detailed documentation of checks, tools and principles.\n* Check out the [CLI reference](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) with detailed documentation of all CLI commands and options.\n* Check out the [library reference](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html) with detailed documentation of public classes and functions.\n* Check out the [API reference](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.\n* Our [release notes](https://oe-python-template.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.\n* In case you want to help us improve \ud83e\udde0 OE Python Template: The [contribution guidelines](https://oe-python-template.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.\n* We gratefully acknowledge the [open source projects](https://oe-python-template.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!\n\n## Star History\n\n<a href=\"https://star-history.com/#helmut-hoffer-von-ankershoffen/oe-python-template\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template&type=Date&theme=dark\" />\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template&type=Date\" />\n <img alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=helmut-hoffer-von-ankershoffen/oe-python-template&type=Date\" />\n </picture>\n</a>\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2025] [Helmut Hoffer von Ankershoffen (helmuthva@gmail.com)] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "\ud83e\udde0 Copier template to scaffold Python projects compliant with best practices and modern tooling.",
"version": "0.12.15",
"project_urls": {
"Changelog": "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases",
"Documentation": "https://oe-python-template.readthedocs.io/en/latest/",
"Homepage": "https://oe-python-template.readthedocs.io/en/latest/",
"Issues": "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues",
"Source": "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template"
},
"split_keywords": [
"act",
" codecov",
" copier",
" cyclonedx",
" detect-secrets",
" devcontainer",
" docker",
" git-cliff",
" jupyter",
" marimo",
" mypy",
" nox",
" oe-python-template",
" pip-audit",
" pip-licenses",
" pre-commit",
" pydantic",
" pypi",
" pytest",
" python",
" readthedocs",
" ruff",
" sonarcloud",
" sonarqube",
" sphinx",
" streamlit",
" typer",
" uv"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2ce3905a2d0b313b7733dc636d95745322fa5d83efb234fb454341a61a1cd522",
"md5": "7885d3df39ecc071bf9ef503bded355f",
"sha256": "e22d4264b2a4802c70cea15968dfc5bb74f80115f22155ebe744f2e5c6eb2ac9"
},
"downloads": -1,
"filename": "oe_python_template-0.12.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7885d3df39ecc071bf9ef503bded355f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 43885,
"upload_time": "2025-04-21T00:03:32",
"upload_time_iso_8601": "2025-04-21T00:03:32.691358Z",
"url": "https://files.pythonhosted.org/packages/2c/e3/905a2d0b313b7733dc636d95745322fa5d83efb234fb454341a61a1cd522/oe_python_template-0.12.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8a2da49d68b27a4624e471edcb4f8c1aec7365fbc0e11592bee3e16406d5194b",
"md5": "49669c7e828da93010dab4e81a7296f1",
"sha256": "7f6e1f529b289d43120744873d464c88c2fec48ad1a2888ca6d2e78759342b29"
},
"downloads": -1,
"filename": "oe_python_template-0.12.15.tar.gz",
"has_sig": false,
"md5_digest": "49669c7e828da93010dab4e81a7296f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 42400,
"upload_time": "2025-04-21T00:03:34",
"upload_time_iso_8601": "2025-04-21T00:03:34.279728Z",
"url": "https://files.pythonhosted.org/packages/8a/2d/a49d68b27a4624e471edcb4f8c1aec7365fbc0e11592bee3e16406d5194b/oe_python_template-0.12.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-21 00:03:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "helmut-hoffer-von-ankershoffen",
"github_project": "oe-python-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "oe-python-template"
}
