oe-python-template 0.13.6__tar.gz → 0.13.8__tar.gz

{oe_python_template-0.13.6 → oe_python_template-0.13.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.13.6
+Version: 0.13.8
 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/
@@ -152,35 +152,39 @@ Projects generated with this template come with a comprehensive development tool
 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)
+23. Multi-stage build of fat (all extras) and slim (no extras) multi-arch (arm64 and amd64) Docker images, running non-root within immutable container
+24. 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
+### Multi-head 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:
+Beyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning service and multi-head application. 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/)
+2. Comfortable command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
+3. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)
 4. Cross-platform Graphical User Interface (GUI) with
-   [NiceGUI](https://nicegui.io/) running in native window
+   [NiceGUI](https://nicegui.io/) running in a browser or 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
+7. Modular architecture auto-discovers and registers services, CLI commands, API routes and GUI pages exposed by domain modules
+8. Validation and settings management with [pydantic](https://docs.pydantic.dev/)
+9. System module providing aggregate health and info to the runtime, compiled settings, and further info provided by domain modules
+10. Health and Info available via command, webservice API (info passsword protected) and GUI
+11. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/) 
 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.
+Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box. While this template comes with multiple application interfaces ("heads") - Library, CLI, API, GUI, notebooks, and Streamlit; running native and within Docker - they're included to demonstrate capabilities and provide implementation patterns. You're expected to use this as a foundation, keeping only the interfaces relevant to your project's requirements. The modular architecture makes it easy to:
+
+1. Remove unnecessary interfaces to simplify your codebase
+2. Adapt existing interfaces to your specific use cases 
+3. Focus on your core business logic without reimplementing infrastructure
+4. Add new interfaces while leveraging the existing patterns
+
 
 ## Generate a new project
 
@@ -303,15 +307,12 @@ The following examples run from source - clone this repository using
 ```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]")
 ```

{oe_python_template-0.13.6 → oe_python_template-0.13.8}/README.md

@@ -78,35 +78,39 @@ Projects generated with this template come with a comprehensive development tool
 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)
+23. Multi-stage build of fat (all extras) and slim (no extras) multi-arch (arm64 and amd64) Docker images, running non-root within immutable container
+24. 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
+### Multi-head 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:
+Beyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning service and multi-head application. 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/)
+2. Comfortable command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
+3. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)
 4. Cross-platform Graphical User Interface (GUI) with
-   [NiceGUI](https://nicegui.io/) running in native window
+   [NiceGUI](https://nicegui.io/) running in a browser or 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
+7. Modular architecture auto-discovers and registers services, CLI commands, API routes and GUI pages exposed by domain modules
+8. Validation and settings management with [pydantic](https://docs.pydantic.dev/)
+9. System module providing aggregate health and info to the runtime, compiled settings, and further info provided by domain modules
+10. Health and Info available via command, webservice API (info passsword protected) and GUI
+11. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/) 
 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.
+Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box. While this template comes with multiple application interfaces ("heads") - Library, CLI, API, GUI, notebooks, and Streamlit; running native and within Docker - they're included to demonstrate capabilities and provide implementation patterns. You're expected to use this as a foundation, keeping only the interfaces relevant to your project's requirements. The modular architecture makes it easy to:
+
+1. Remove unnecessary interfaces to simplify your codebase
+2. Adapt existing interfaces to your specific use cases 
+3. Focus on your core business logic without reimplementing infrastructure
+4. Add new interfaces while leveraging the existing patterns
+
 
 ## Generate a new project
 
@@ -229,15 +233,12 @@ The following examples run from source - clone this repository using
 ```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]")
 ```

{oe_python_template-0.13.6 → oe_python_template-0.13.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.13.6"
+version = "0.13.8"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [{ name = "Helmut Hoffer von Ankershoffen", email = "helmuthva@gmail.com" }]
@@ -279,7 +279,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.13.6"
+current_version = "0.13.8"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"