oe-python-template 0.6.21__tar.gz → 0.6.22__tar.gz

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.6.20-1-gd9c2a33
+_commit: v0.6.21-1-g6baf50a
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/.github/workflows/codeql.yml

@@ -59,7 +59,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      # Add any setup steps before running the `github/codeql-action/init` action.
+        # 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)

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/CHANGELOG.md

@@ -1,6 +1,13 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.6.21](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.20..0.6.21) - 2025-03-18
+## [0.6.22](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.21..0.6.22) - 2025-03-19
+
+### 📚 Documentation
+
+- Polish - ([9af66c9](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/9af66c97bb04eeebd63395cff33b5a650dd081aa))
+
+
+## [0.6.21](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.20..v0.6.21) - 2025-03-18
 
 ### ⚙️ Miscellaneous Tasks
 

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.6.21
+Version: 0.6.22
 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/
@@ -104,9 +104,19 @@ Description-Content-Type: text/markdown
 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 
 Use Cases:
-1) Fast and easy to use project setup
-2) Consistent update of already scaffolded projects to benefit from new and improved features.
-3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
+1) Fast and easy generation of Python projects from this template
+2) Seamless updates of projects when improvements to the template are released
+3) Generates a fully-functional Python package with test and build automation featuring
+   - Service architecture suiteable for use as shared library
+   - Command-line interface (CLI)
+   - Versioned Web API
+   - Integration examples with Notebooks and Dashboards
+   - Complete developer-tooling with formatting, linting, type checking etc.
+   - CI/CD pipeline for GitHub, PyPI, and Docker registries
+   - Unit and E2E tests including parallel and matrix-testing
+   - Release artifacts include SBOM, license information, and test coverage
+   - Auto-generated documentation published to Read The Docs
+   - Service integrations monitoring code quality, dependencies, and security
 
 ## Scaffolding
 
@@ -157,7 +167,7 @@ Notes:
 
 ## Overview
 
-Adding OE Python Template to your project as a dependency is easy.
+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
@@ -165,6 +175,7 @@ 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
 ```
@@ -172,14 +183,14 @@ 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 serve           # serves webservice API
-uvx oe-python-template serve --port=4711 # serves webservice API on port 4711
+uvx oe-python-template hello-world       # prints "Hello, world! [..]"
+uvx oe-python-template serve             # serves web API
+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 webservice 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.
+* 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)
 
 
@@ -217,7 +228,7 @@ This project is designed with operational excellence in mind, using modern Pytho
 
 ## Usage Examples
 
-The following examples run from source. Clone this repository first using
+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:

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/README.md

@@ -43,9 +43,19 @@
 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 
 Use Cases:
-1) Fast and easy to use project setup
-2) Consistent update of already scaffolded projects to benefit from new and improved features.
-3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
+1) Fast and easy generation of Python projects from this template
+2) Seamless updates of projects when improvements to the template are released
+3) Generates a fully-functional Python package with test and build automation featuring
+   - Service architecture suiteable for use as shared library
+   - Command-line interface (CLI)
+   - Versioned Web API
+   - Integration examples with Notebooks and Dashboards
+   - Complete developer-tooling with formatting, linting, type checking etc.
+   - CI/CD pipeline for GitHub, PyPI, and Docker registries
+   - Unit and E2E tests including parallel and matrix-testing
+   - Release artifacts include SBOM, license information, and test coverage
+   - Auto-generated documentation published to Read The Docs
+   - Service integrations monitoring code quality, dependencies, and security
 
 ## Scaffolding
 
@@ -96,7 +106,7 @@ Notes:
 
 ## Overview
 
-Adding OE Python Template to your project as a dependency is easy.
+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
@@ -104,6 +114,7 @@ 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
 ```
@@ -111,14 +122,14 @@ 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 serve           # serves webservice API
-uvx oe-python-template serve --port=4711 # serves webservice API on port 4711
+uvx oe-python-template hello-world       # prints "Hello, world! [..]"
+uvx oe-python-template serve             # serves web API
+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 webservice 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.
+* 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)
 
 
@@ -156,7 +167,7 @@ This project is designed with operational excellence in mind, using modern Pytho
 
 ## Usage Examples
 
-The following examples run from source. Clone this repository first using
+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:

oe_python_template-0.6.22/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [0.6.22](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.21..v0.6.22) - 2025-03-19
+
+### 📚 Documentation
+
+- Polish - ([9af66c9](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/9af66c97bb04eeebd63395cff33b5a650dd081aa))
+
+
+

oe_python_template-0.6.22/VERSION

@@ -0,0 +1 @@
+0.6.22

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/docs/partials/README_main.md

@@ -1,9 +1,19 @@
 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 
 Use Cases:
-1) Fast and easy to use project setup
-2) Consistent update of already scaffolded projects to benefit from new and improved features.
-3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
+1) Fast and easy generation of Python projects from this template
+2) Seamless updates of projects when improvements to the template are released
+3) Generates a fully-functional Python package with test and build automation featuring
+   - Service architecture suiteable for use as shared library
+   - Command-line interface (CLI)
+   - Versioned Web API
+   - Integration examples with Notebooks and Dashboards
+   - Complete developer-tooling with formatting, linting, type checking etc.
+   - CI/CD pipeline for GitHub, PyPI, and Docker registries
+   - Unit and E2E tests including parallel and matrix-testing
+   - Release artifacts include SBOM, license information, and test coverage
+   - Auto-generated documentation published to Read The Docs
+   - Service integrations monitoring code quality, dependencies, and security
 
 ## Scaffolding
 
@@ -54,7 +64,7 @@ Notes:
 
 ## Overview
 
-Adding OE Python Template to your project as a dependency is easy.
+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
@@ -62,6 +72,7 @@ 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
 ```
@@ -69,14 +80,14 @@ 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 serve           # serves webservice API
-uvx oe-python-template serve --port=4711 # serves webservice API on port 4711
+uvx oe-python-template hello-world       # prints "Hello, world! [..]"
+uvx oe-python-template serve             # serves web API
+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 webservice 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.
+* 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)
 
 
@@ -114,7 +125,7 @@ This project is designed with operational excellence in mind, using modern Pytho
 
 ## Usage Examples
 
-The following examples run from source. Clone this repository first using
+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:

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/docs/source/conf.py

@@ -29,7 +29,7 @@ extensions = [
 project = "oe-python-template"
 author = "Helmut Hoffer von Ankershoffen"
 copyright = f" (c) 2025-{datetime.now(UTC).year}, {author}"  # noqa: A001
-version = "0.6.21"
+version = "0.6.22"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template"

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/pyproject.toml

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

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/sonar-project.properties

@@ -1,6 +1,6 @@
 sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template
 sonar.organization=helmut-hoffer-von-ankershoffen
-sonar.projectVersion=0.6.21
+sonar.projectVersion=0.6.22
 sonar.projectDescription=🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 sonar.links.homepage=https://oe-python-template.readthedocs.io/en/latest/
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/template/.github/workflows/codeql.yml

@@ -59,7 +59,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      # Add any setup steps before running the `github/codeql-action/init` action.
+        # 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)

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/template/docs/partials/README_main.md.jinja

@@ -1,9 +1,19 @@
 {{ project_description }}
 
 Use Cases:
-1) Fast and easy to use project setup
-2) Consistent update of already scaffolded projects to benefit from new and improved features.
-3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
+1) Fast and easy generation of Python projects from this template
+2) Seamless updates of projects when improvements to the template are released
+3) Generates a fully-functional Python package with test and build automation featuring
+   - Service architecture suiteable for use as shared library
+   - Command-line interface (CLI)
+   - Versioned Web API
+   - Integration examples with Notebooks and Dashboards
+   - Complete developer-tooling with formatting, linting, type checking etc.
+   - CI/CD pipeline for GitHub, PyPI, and Docker registries
+   - Unit and E2E tests including parallel and matrix-testing
+   - Release artifacts include SBOM, license information, and test coverage
+   - Auto-generated documentation published to Read The Docs
+   - Service integrations monitoring code quality, dependencies, and security
 
 ## Scaffolding
 
@@ -54,7 +64,7 @@ Notes:
 
 ## Overview
 
-Adding {{ project_name }} to your project as a dependency is easy.
+Adding {{ project_name }} to your project as a dependency is easy. See below for usage examples.
 
 ```shell
 uv add {{ pypi_distribution_name }}             # add dependency to your project
@@ -62,6 +72,7 @@ uv add {{ pypi_distribution_name }}             # 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 {{ pypi_distribution_name }}        # add dependency to your project
 ```
@@ -69,14 +80,14 @@ pip install {{ pypi_distribution_name }}        # add dependency to your project
 Executing the command line interface (CLI) in an isolated Python environment is just as easy:
 
 ```shell
-uvx {{ pypi_distribution_name}} hello-world     # prints "Hello, world! [..]"
-uvx {{ pypi_distribution_name}} serve           # serves webservice API
-uvx {{ pypi_distribution_name}} serve --port=4711 # serves webservice API on port 4711
+uvx {{ pypi_distribution_name}} hello-world       # prints "Hello, world! [..]"
+uvx {{ pypi_distribution_name}} serve             # serves web API
+uvx {{ pypi_distribution_name}} serve --port=4711 # serves web API on port 4711
 ```
 
 Notes:
 * The API is versioned, mounted at `/api/v1` resp. `/api/v2`
-* While serving the webservice 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.
+* 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)
 
 
@@ -114,7 +125,7 @@ This project is designed with operational excellence in mind, using modern Pytho
 
 ## Usage Examples
 
-The following examples run from source. Clone this repository first using
+The following examples run from source - clone this repository using
 `git clone {{ github_repository_url_ssh }}`.
 
 ### Minimal Python Script:

{oe_python_template-0.6.21 → oe_python_template-0.6.22}/uv.lock

@@ -2075,7 +2075,7 @@ wheels = [
 
 [[package]]
 name = "oe-python-template"
-version = "0.6.21"
+version = "0.6.22"
 source = { editable = "." }
 dependencies = [
     { name = "fastapi", extra = ["all", "standard"] },

oe_python_template-0.6.21/RELEASE_NOTES.md

@@ -1,8 +0,0 @@
-## [0.6.21](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.20..v0.6.21) - 2025-03-18
-
-### ⚙️ Miscellaneous Tasks
-
-- *(gh)* Uv action - ([bc632fe](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/bc632fee8ca1d3e3cb4495d12e134f18dc855028))
-
-
-

oe_python_template-0.6.21/VERSION

@@ -1 +0,0 @@
-0.6.21

oe_python_template-0.6.21/docs/source/_static/openapi_v1.yaml

@@ -1,188 +0,0 @@
-components:
-  schemas:
-    EchoRequest:
-      description: Request model for echo endpoint.
-      properties:
-        text:
-          description: The text to echo back
-          examples:
-          - Hello, world!
-          minLength: 1
-          title: Text
-          type: string
-      required:
-      - text
-      title: EchoRequest
-      type: object
-    EchoResponse:
-      description: Response model for echo endpoint.
-      properties:
-        message:
-          description: The message content
-          examples:
-          - Hello, world!
-          minLength: 1
-          title: Message
-          type: string
-      required:
-      - message
-      title: EchoResponse
-      type: object
-    HTTPValidationError:
-      properties:
-        detail:
-          items:
-            $ref: '#/components/schemas/ValidationError'
-          title: Detail
-          type: array
-      title: HTTPValidationError
-      type: object
-    Health:
-      description: Health status model.
-      properties:
-        reason:
-          anyOf:
-          - type: string
-          - type: 'null'
-          title: Reason
-        status:
-          $ref: '#/components/schemas/_HealthStatus'
-      required:
-      - status
-      title: Health
-      type: object
-    HelloWorldResponse:
-      description: Response model for hello-world endpoint.
-      properties:
-        message:
-          description: The hello world message
-          examples:
-          - Hello, world!
-          title: Message
-          type: string
-      required:
-      - message
-      title: HelloWorldResponse
-      type: object
-    ValidationError:
-      properties:
-        loc:
-          items:
-            anyOf:
-            - type: string
-            - type: integer
-          title: Location
-          type: array
-        msg:
-          title: Message
-          type: string
-        type:
-          title: Error Type
-          type: string
-      required:
-      - loc
-      - msg
-      - type
-      title: ValidationError
-      type: object
-    _HealthStatus:
-      description: Health status enumeration.
-      enum:
-      - UP
-      - DOWN
-      title: _HealthStatus
-      type: string
-info:
-  contact:
-    email: helmuthva@gmail.com
-    name: Helmut Hoffer von Ankershoffen
-    url: https://github.com/helmut-hoffer-von-ankershoffen
-  termsOfService: https://oe-python-template.readthedocs.io/en/latest/
-  title: OE Python Template
-  version: 1.0.0
-openapi: 3.1.0
-paths:
-  /echo:
-    post:
-      description: "Echo back the provided text.\n\nArgs:\n    request (EchoRequest):\
-        \ The request containing the text to echo back.\n\nReturns:\n    EchoResponse:\
-        \ A response containing the echoed text.\n\nRaises:\n    422 Unprocessable\
-        \ Entity: If text is not provided or empty."
-      operationId: echo_echo_post
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/EchoRequest'
-        required: true
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/EchoResponse'
-          description: Successful Response
-        '422':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/HTTPValidationError'
-          description: Validation Error
-      summary: Echo
-      tags:
-      - Basics
-  /health:
-    get:
-      description: "Check the health of the service.\n\nThis endpoint returns the\
-        \ health status of the service.\nThe health status can be either UP or DOWN.\n\
-        If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
-        \ the status will be DOWN and a reason will be provided.\nThe response will\
-        \ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
-        \ Server Error status code if the service is unhealthy.\n\nReturns:\n    Health:\
-        \ The health status of the service."
-      operationId: health_health_get
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Health'
-          description: Successful Response
-      summary: Health
-      tags:
-      - Observability
-  /healthz:
-    get:
-      description: "Check the health of the service.\n\nThis endpoint returns the\
-        \ health status of the service.\nThe health status can be either UP or DOWN.\n\
-        If the service is healthy, the status will be UP.\nIf the service is unhealthy,\
-        \ the status will be DOWN and a reason will be provided.\nThe response will\
-        \ have a 200 OK status code if the service is healthy,\nand a 500 Internal\
-        \ Server Error status code if the service is unhealthy.\n\nReturns:\n    Health:\
-        \ The health status of the service."
-      operationId: health_healthz_get
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Health'
-          description: Successful Response
-      summary: Health
-      tags:
-      - Observability
-  /hello-world:
-    get:
-      description: "Return a hello world message.\n\nReturns:\n    HelloWorldResponse:\
-        \ A response containing the hello world message."
-      operationId: hello_world_hello_world_get
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/HelloWorldResponse'
-          description: Successful Response
-      summary: Hello World
-      tags:
-      - Basics