oe-python-template 0.6.25__tar.gz → 0.6.27__tar.gz

{oe_python_template-0.6.25 → oe_python_template-0.6.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.6.25
+Version: 0.6.27
 Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
@@ -107,38 +107,40 @@ This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to
 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.
 
 Features:
-- Package management with [uv](https://github.com/astral-sh/uv)
-- Code formatting with [Ruff](https://github.com/astral-sh/ruff)
-- Linting with [Ruff](https://github.com/astral-sh/ruff)
-- Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
-- 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)
-- Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
-- Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
-- Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
-- CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
-- CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
-- Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
-- Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
-- Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks
-- Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
-- Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
-- Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
-- Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
-- Documentation published to [Read The Docs](https://readthedocs.org/)
-- Interactive OpenAPI specification with [Swagger](https://swagger.io/)
-- Python package published to [PyPI](https://pypi.org/)
-- 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)
-- One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
+1. Package management with [uv](https://github.com/astral-sh/uv)
+2. Code formatting with [Ruff](https://github.com/astral-sh/ruff)
+3. Linting with [Ruff](https://github.com/astral-sh/ruff)
+4. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
+5. 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)
+6. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
+7. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
+8. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
+9. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
+10. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
+11. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
+12. Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
+13. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks
+14. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
+15. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
+16. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
+17. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
+18. Documentation published to [Read The Docs](https://readthedocs.org/)
+19. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
+20. Python package published to [PyPI](https://pypi.org/)
+21. 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)
+22. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
+23. Settings for use with [VSCode](https://code.visualstudio.com/)
+24. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
 
 The generated project includes code, documentation and configuration of a fully functioning demo-application and service, which can be used as a starting point for your own project.
-- Service architecture suitable for use as shared library
-- Validation with [pydantic](https://docs.pydantic.dev/)
-- Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
-- Versioned Web API with [FastAPI](https://fastapi.tiangolo.com/)
-- [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
-- Simple Web UI with [Streamlit](https://streamlit.io/)
-- 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/)
-- Documentation including badges, setup instructions, contribution guide and security policy
+1. Service architecture suitable for use as shared library
+2. Validation with [pydantic](https://docs.pydantic.dev/)
+3. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
+4. Versioned Web API with [FastAPI](https://fastapi.tiangolo.com/)
+5. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
+6. Simple Web UI with [Streamlit](https://streamlit.io/)
+7. 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/)
+8. Documentation including badges, setup instructions, contribution guide and security policy
 
 Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
 
@@ -187,9 +189,9 @@ external services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, a
 ./n bump
 ```
 Notes:
-* You can remove this section post having successfully generated your project.
-* The following sections refer to the dummy application and service provided by this template.
-  Use them as inspiration and adapt them to your own project.
+1. You can remove this section post having successfully generated your project.
+2. The following sections refer to the dummy application and service provided by this template.
+   Use them as inspiration and adapt them to your own project.
 
 ## Overview
 
@@ -215,9 +217,9 @@ uvx oe-python-template serve --port=4711 # serves web API on port 4711
 ```
 
 Notes:
-* The API is versioned, mounted at `/api/v1` resp. `/api/v2`
-* 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.
-* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
+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:
@@ -235,21 +237,21 @@ uvx oe-python-template serve --help
 
 This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
 
-* Various examples demonstrating usage:
-  - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
-  - [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
-  - [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
-* [Complete reference documentation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs
-* [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
-* 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/))
-* Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
-* 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))
-* [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)
-* Additional code security checks using [CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/code-scanning)
-* [Security Policy](SECURITY.md)
-* [License](LICENSE) compliant with the Open Source Initiative (OSI)
-* 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)
-* Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
+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](https://oe-python-template.readthedocs.io/en/latest/reference.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

{oe_python_template-0.6.25 → oe_python_template-0.6.27}/README.md

@@ -46,38 +46,40 @@ This [Copier](https://copier.readthedocs.io/en/stable/) template enables you to
 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.
 
 Features:
-- Package management with [uv](https://github.com/astral-sh/uv)
-- Code formatting with [Ruff](https://github.com/astral-sh/ruff)
-- Linting with [Ruff](https://github.com/astral-sh/ruff)
-- Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
-- 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)
-- Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
-- Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
-- Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
-- CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
-- CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
-- Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
-- Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
-- Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks
-- Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
-- Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
-- Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
-- Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
-- Documentation published to [Read The Docs](https://readthedocs.org/)
-- Interactive OpenAPI specification with [Swagger](https://swagger.io/)
-- Python package published to [PyPI](https://pypi.org/)
-- 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)
-- One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
+1. Package management with [uv](https://github.com/astral-sh/uv)
+2. Code formatting with [Ruff](https://github.com/astral-sh/ruff)
+3. Linting with [Ruff](https://github.com/astral-sh/ruff)
+4. Static type checking with [mypy](https://mypy.readthedocs.io/en/stable/)
+5. 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)
+6. Unit and E2E testing with [pytest](https://docs.pytest.org/en/stable/) including parallel test execution
+7. Matrix testing in multiple environments with [nox](https://nox.thea.codes/en/stable/)
+8. Test coverage reported with [Codecov](https://codecov.io/) and published as release artifact
+9. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
+10. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
+11. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
+12. Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
+13. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks
+14. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
+15. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
+16. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
+17. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
+18. Documentation published to [Read The Docs](https://readthedocs.org/)
+19. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
+20. Python package published to [PyPI](https://pypi.org/)
+21. 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)
+22. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
+23. Settings for use with [VSCode](https://code.visualstudio.com/)
+24. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
 
 The generated project includes code, documentation and configuration of a fully functioning demo-application and service, which can be used as a starting point for your own project.
-- Service architecture suitable for use as shared library
-- Validation with [pydantic](https://docs.pydantic.dev/)
-- Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
-- Versioned Web API with [FastAPI](https://fastapi.tiangolo.com/)
-- [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
-- Simple Web UI with [Streamlit](https://streamlit.io/)
-- 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/)
-- Documentation including badges, setup instructions, contribution guide and security policy
+1. Service architecture suitable for use as shared library
+2. Validation with [pydantic](https://docs.pydantic.dev/)
+3. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
+4. Versioned Web API with [FastAPI](https://fastapi.tiangolo.com/)
+5. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
+6. Simple Web UI with [Streamlit](https://streamlit.io/)
+7. 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/)
+8. Documentation including badges, setup instructions, contribution guide and security policy
 
 Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
 
@@ -126,9 +128,9 @@ external services such as CloudCov, SonarQube Cloud, Read The Docs, Docker.io, a
 ./n bump
 ```
 Notes:
-* You can remove this section post having successfully generated your project.
-* The following sections refer to the dummy application and service provided by this template.
-  Use them as inspiration and adapt them to your own project.
+1. You can remove this section post having successfully generated your project.
+2. The following sections refer to the dummy application and service provided by this template.
+   Use them as inspiration and adapt them to your own project.
 
 ## Overview
 
@@ -154,9 +156,9 @@ uvx oe-python-template serve --port=4711 # serves web API on port 4711
 ```
 
 Notes:
-* The API is versioned, mounted at `/api/v1` resp. `/api/v2`
-* 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.
-* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
+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:
@@ -174,21 +176,21 @@ uvx oe-python-template serve --help
 
 This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
 
-* Various examples demonstrating usage:
-  - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py)
-  - [Streamlit web application](https://oe-python-template.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
-  - [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
-* [Complete reference documentation](https://oe-python-template.readthedocs.io/en/latest/reference.html) on Read the Docs
-* [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
-* 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/))
-* Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
-* 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))
-* [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)
-* Additional code security checks using [CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/code-scanning)
-* [Security Policy](SECURITY.md)
-* [License](LICENSE) compliant with the Open Source Initiative (OSI)
-* 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)
-* Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
+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](https://oe-python-template.readthedocs.io/en/latest/reference.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

{oe_python_template-0.6.25 → oe_python_template-0.6.27}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.6.25"
+version = "0.6.27"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [
@@ -79,9 +79,15 @@ Changelog = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-templat
 Issues = "https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues"
 
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling==1.27.0"]
 build-backend = "hatchling.build"
 
+[tool.hatch.build]
+include = ["src/*"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/oe_python_template"]
+
 [project.optional-dependencies]
 examples = [
     "streamlit>=1.43.2",
@@ -242,7 +248,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.6.25"
+current_version = "0.6.27"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

oe_python_template-0.6.25/.act-env-public

@@ -1 +0,0 @@
-GITHUB_WORKFLOW_RUNTIME=ACT

oe_python_template-0.6.25/.copier-answers.yml

@@ -1,23 +0,0 @@
-_commit: v0.6.24-1-g398f37a
-_src_path: .
-author_email: helmuthva@gmail.com
-author_github_username: helmut-hoffer-von-ankershoffen
-author_name: Helmut Hoffer von Ankershoffen
-docker_io_enabled: true
-docker_io_image_name: oe-python-template
-docker_io_owner: helmuthva
-github_repository_name: oe-python-template
-github_repository_owner: helmut-hoffer-von-ankershoffen
-github_repository_url_https: https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
-github_repository_url_ssh: git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git
-org_email: helmuthva@gmail.com
-org_name: Helmut Hoffer von Ankershoffen
-project_description: Copier template to scaffold Python projects compliant with best
-    practices and modern tooling.
-project_icon: 🧠
-project_name: OE Python Template
-pypi_distribution_name: oe-python-template
-readthedocs_domain: readthedocs.org
-readthedocs_project_key: oe-python-template
-sonarqube_key: helmut-hoffer-von-ankershoffen_oe-python-template
-streamlit_project_key: oe-python-template

oe_python_template-0.6.25/.devcontainer/Dockerfile

@@ -1,7 +0,0 @@
-FROM mcr.microsoft.com/devcontainers/python:1-3.11-bullseye
-
-RUN curl --proto '=https' --tlsv1.2 -fsSL https://deb.nodesource.com/setup_22.x | bash - && \
-    apt update -y && \
-    apt install -y --no-install-recommends curl gnupg2 jq less nano nodejs procps psmisc && \
-    apt-get clean && \
-    rm -rf /var/lib/apt/lists/*

oe_python_template-0.6.25/.devcontainer/devcontainer.json

@@ -1,51 +0,0 @@
-{
-	"build": {
-		"dockerfile": "Dockerfile"
-	},
-	"features": {
-		"ghcr.io/devcontainers/features/github-cli:1": {},
-		"ghcr.io/va-h/devcontainers-features/uv:1": {},
-		"ghcr.io/dhoeric/features/act:1": {},
-		"ghcr.io/devcontainers/features/docker-in-docker:2": {},
-		"ghcr.io/devcontainers/features/java:1": {},
-		"ghcr.io/devcontainers/features/node:1": {}
-	},
-	"onCreateCommand": ".devcontainer/onCreateCommand",
-	"postCreateCommand": ".devcontainer/postCreateCommand",
-	"postAttachCommand": ".devcontainer/postAttachCommand",
-	"customizations": {
-		// Configure properties specific to VS Code.
-		"vscode": {
-			// Add the IDs of extensions you want installed when the container is created.
-			"extensions": [
-				"charliermarsh.ruff",
-				"codecov.codecov",
-				"donjayamanne.python-environment-manager",
-				"fill-labs.dependi",
-				"github.vscode-github-actions",
-				"github.copilot",
-				"github.copilot-chat",
-				"gruntfuggly.todo-tree",
-		        "joshrmosier.streamlit-runner",
-				"kaih2o.python-resource-monitor",
-		        "marimo-team.vscode-marimo",
-				"mikestead.dotenv",
-				"ms-azuretools.vscode-docker",
-				"ms-python.debugpy",
-				"ms-python.python",
-				"ms-python.vscode-pylance",
-				"ms-toolsai.jupyter",
-				"oderwat.indent-rainbow",
-				"samuelcolvin.jinjahtml",
-				"sonarsource.sonarlint-vscode",
-				"tamasfe.even-better-toml",
-				"tomoki1207.pdf",
-				"wayou.vscode-todo-highlight"
-			]
-		}
-	},
-	"mounts": [
-		"source=${localEnv:HOME}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached"
-	],
-	"forwardPorts": []
-}

oe_python_template-0.6.25/.devcontainer/onCreateCommand

@@ -1,9 +0,0 @@
-#!/bin/sh
-
-echo "onCreateCommand: start"
-git config --global --add safe.directory /workspaces/oe-python-template
-rm -rf .nox
-rm -rf .venv
-uv sync --frozen
-uv run pre-commit install
-echo "onCreateCommand: end"

oe_python_template-0.6.25/.devcontainer/postAttachCommand

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-echo "postAttachCommand:start"
-echo "postAttachCommand:end"

oe_python_template-0.6.25/.devcontainer/postCreateCommand

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-echo "postCreateCommand:start"
-echo "postCreateCommand:end"

oe_python_template-0.6.25/.env.example

@@ -1 +0,0 @@
-THE_KEY=A value

oe_python_template-0.6.25/.github/copilot-instructions.md

@@ -1,5 +0,0 @@
-Always conform to the coding styles defined in CODE_STYLE.md in the root
-directory of this repository when generating code.
-
-Learn about tools to use in CONTRIBUTING.md in the root directory of this
-repository.

oe_python_template-0.6.25/.github/dependabot.yml

@@ -1,13 +0,0 @@
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  - package-ecosystem: "pip"
-    directory: "/"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"

oe_python_template-0.6.25/.github/workflows/codeql.yml

@@ -1,100 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL Advanced"
-
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
-  schedule:
-    - cron: "22 3 * * 2"
-
-jobs:
-  analyze:
-    name: Analyze (${{ matrix.language }})
-    # Runner size impacts CodeQL analysis time. To learn more, please see:
-    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
-    #   - https://gh.io/supported-runners-and-hardware-resources
-    #   - https://gh.io/using-larger-runners (GitHub.com only)
-    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
-    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
-    permissions:
-      # required for all workflows
-      security-events: write
-
-      # required to fetch internal or private CodeQL packs
-      packages: read
-
-      # only required for workflows in private repositories
-      actions: read
-      contents: read
-
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - language: actions
-            build-mode: none
-          - language: python
-            build-mode: none
-          # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
-          # Use `c-cpp` to analyze code written in C, C++ or both
-          # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
-          # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
-          # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
-          # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
-          # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
-          # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-        # Add any setup steps before running the `github/codeql-action/init` action.
-      # This includes steps like installing compilers or runtimes (`actions/setup-node`
-      # or others). This is typically only required for manual builds.
-      # - name: Setup runtime (example)
-      #   uses: actions/setup-example@v1
-
-      # Initializes the CodeQL tools for scanning.
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
-        with:
-          languages: ${{ matrix.language }}
-          build-mode: ${{ matrix.build-mode }}
-          # If you wish to specify custom queries, you can do so here or in a config file.
-          # By default, queries listed here will override any specified in a config file.
-          # Prefix the list here with "+" to use these queries and those in the config file.
-
-          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-          queries: security-extended,security-and-quality
-
-      # If the analyze step fails for one of the languages you are analyzing with
-      # "We were unable to automatically build your code", modify the matrix above
-      # to set the build mode to "manual" for that language. Then modify this step
-      # to build your code.
-      # ℹ️ Command-line programs to run using the OS shell.
-      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-      - if: matrix.build-mode == 'manual'
-        shell: bash
-        run: |
-          echo 'If you are using a "manual" build mode for one or more of the' \
-            'languages you are analyzing, replace this with the commands to build' \
-            'your code, for example:'
-          echo '  make bootstrap'
-          echo '  make release'
-          exit 1
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
-        with:
-          category: "/language:${{matrix.language}}"