oe-python-template-example 0.2.17__tar.gz → 0.3.1__tar.gz

{oe_python_template_example-0.2.17 → oe_python_template_example-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.2.17
+Version: 0.3.1
 Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/
@@ -132,8 +132,8 @@ Projects generated with this template come with a comprehensive development tool
 13. 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
 14. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
 15. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
-16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
-17. Documentation published to [Read The Docs](https://readthedocs.org/)
+16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
+17. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
 18. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
 19. Python package published to [PyPI](https://pypi.org/)
 20. 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)
@@ -250,7 +250,7 @@ This project is designed with operational excellence in mind, using modern Pytho
   a. [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py)
   b. [Streamlit web application](https://oe-python-template-example.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
   c. [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py) notebook
-2. [Complete reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html) on Read the Docs
+2. Complete reference documentation [for the library](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html), [for the CLI](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html) and [for the API](https://oe-python-template-example.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-example) 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-example/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))
@@ -286,19 +286,16 @@ message = Service.get_hello_world()
 console.print(f"[blue]{message}[/blue]")
 ```
 
-[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) -
-[Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)
+[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html)
+
 
 ### Streamlit App
 
-Serve the functionality provided by OE Python Template Example in the web by
-easily integrating the service into a Streamlit application.
+Serve the functionality provided by OE Python Template Example in the web by easily integrating the service into a Streamlit application.
 
-[Try it out!](https://oe-python-template-example.streamlit.app) -
-[Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/streamlit.py)
+[Try it out!](https://oe-python-template-example.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/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
@@ -374,6 +371,9 @@ uvx oe-python-template-example openapi --output-format=json
 uvx oe-python-template-example serve
 ```
 
+See the [reference documentation of the CLI](https://oe-python-template-example.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.
@@ -444,6 +444,9 @@ echo "Shutting down the API container ..."
 docker compose down
 ```
 
+* See the [reference documentation of the API](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) for detailed documentation of all API operations and parameters.
+
+
 ## Extra: Lorem Ipsum
 
 Nothing yet
@@ -457,7 +460,7 @@ Nothing yet
 * Check out the [API Reference](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
 * Our [release notes](https://oe-python-template-example.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 Example: The [contribution guidelines](https://oe-python-template-example.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
-* We gratefully acknowledge the [open source projects](ATTRIBUTIONS.md) that this project builds upon. Thank you to all these wonderful contributors!
+* We gratefully acknowledge the [open source projects](https://oe-python-template-example.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!
 
 ## Star History
 

{oe_python_template_example-0.2.17 → oe_python_template_example-0.3.1}/README.md

@@ -71,8 +71,8 @@ Projects generated with this template come with a comprehensive development tool
 13. 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
 14. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
 15. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
-16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
-17. Documentation published to [Read The Docs](https://readthedocs.org/)
+16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation for the library, CLI, and API
+17. Documentation published to [Read The Docs](https://readthedocs.org/) including generation of PDF and single page HTML versions
 18. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
 19. Python package published to [PyPI](https://pypi.org/)
 20. 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)
@@ -189,7 +189,7 @@ This project is designed with operational excellence in mind, using modern Pytho
   a. [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py)
   b. [Streamlit web application](https://oe-python-template-example.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
   c. [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py) notebook
-2. [Complete reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html) on Read the Docs
+2. Complete reference documentation [for the library](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html), [for the CLI](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html) and [for the API](https://oe-python-template-example.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-example) 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-example/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))
@@ -225,19 +225,16 @@ message = Service.get_hello_world()
 console.print(f"[blue]{message}[/blue]")
 ```
 
-[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) -
-[Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/reference.html)
+[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html)
+
 
 ### Streamlit App
 
-Serve the functionality provided by OE Python Template Example in the web by
-easily integrating the service into a Streamlit application.
+Serve the functionality provided by OE Python Template Example in the web by easily integrating the service into a Streamlit application.
 
-[Try it out!](https://oe-python-template-example.streamlit.app) -
-[Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/streamlit.py)
+[Try it out!](https://oe-python-template-example.streamlit.app) - [Show the code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/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
@@ -313,6 +310,9 @@ uvx oe-python-template-example openapi --output-format=json
 uvx oe-python-template-example serve
 ```
 
+See the [reference documentation of the CLI](https://oe-python-template-example.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.
@@ -383,6 +383,9 @@ echo "Shutting down the API container ..."
 docker compose down
 ```
 
+* See the [reference documentation of the API](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) for detailed documentation of all API operations and parameters.
+
+
 ## Extra: Lorem Ipsum
 
 Nothing yet
@@ -396,7 +399,7 @@ Nothing yet
 * Check out the [API Reference](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
 * Our [release notes](https://oe-python-template-example.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 Example: The [contribution guidelines](https://oe-python-template-example.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
-* We gratefully acknowledge the [open source projects](ATTRIBUTIONS.md) that this project builds upon. Thank you to all these wonderful contributors!
+* We gratefully acknowledge the [open source projects](https://oe-python-template-example.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!
 
 ## Star History
 

{oe_python_template_example-0.2.17 → oe_python_template_example-0.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.2.17"
+version = "0.3.1"
 description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
 readme = "README.md"
 authors = [
@@ -245,6 +245,7 @@ markers = [
     "no_extras: tests that do require no extras installed",
     "scheduled: tests to run on a schedule",
     "sequential: exclude from parallel test execution",
+    "skip_with_act: don't run with act",
     # Custom
     # Nothing yet
 ]
@@ -263,7 +264,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.2.17"
+current_version = "0.3.1"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"