oe-python-template 0.9.1__tar.gz → 0.9.2__tar.gz

{oe_python_template-0.9.1 → oe_python_template-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.9.1
+Version: 0.9.2
 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/
@@ -247,7 +247,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/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
+2. Complete reference documentation [for the library](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html), [for the CLI](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) and [for the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) on Read the Docs
 3. [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
 4. Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
 5. Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
@@ -283,9 +283,8 @@ message = Service.get_hello_world()
 console.print(f"[blue]{message}[/blue]")
 ```
 
-[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template.readthedocs.io/en/latest/reference.html)
+[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html)
 
-See the [reference documentation of the library](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html) for detailed documentation of public classes and functions you can use in your code.
 
 ### Streamlit App
 
@@ -438,6 +437,9 @@ echo "Shutting down the API container ..."
 docker compose down
 ```
 
+* See the [reference documentation of the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) for detailed documentation of all API operations and parameters.
+
+
 ## Extra: Lorem Ipsum
 
 Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.

{oe_python_template-0.9.1 → oe_python_template-0.9.2}/README.md

@@ -186,7 +186,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/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
+2. Complete reference documentation [for the library](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html), [for the CLI](https://oe-python-template.readthedocs.io/en/latest/cli_reference.html) and [for the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) on Read the Docs
 3. [Transparent test coverage](https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template) including unit and E2E tests (reported on Codecov)
 4. Matrix tested with [multiple python versions](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py) to ensure compatibility (powered by [Nox](https://nox.thea.codes/en/stable/))
 5. Compliant with modern linting and formatting standards (powered by [Ruff](https://github.com/astral-sh/ruff))
@@ -222,9 +222,8 @@ message = Service.get_hello_world()
 console.print(f"[blue]{message}[/blue]")
 ```
 
-[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template.readthedocs.io/en/latest/reference.html)
+[Show script code](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/examples/script.py) - [Read the reference documentation](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html)
 
-See the [reference documentation of the library](https://oe-python-template.readthedocs.io/en/latest/lib_reference.html) for detailed documentation of public classes and functions you can use in your code.
 
 ### Streamlit App
 
@@ -377,6 +376,9 @@ echo "Shutting down the API container ..."
 docker compose down
 ```
 
+* See the [reference documentation of the API](https://oe-python-template.readthedocs.io/en/latest/api_reference_v1.html) for detailed documentation of all API operations and parameters.
+
+
 ## Extra: Lorem Ipsum
 
 Dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam.

{oe_python_template-0.9.1 → oe_python_template-0.9.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.9.1"
+version = "0.9.2"
 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" }]
@@ -131,7 +131,7 @@ dev = [
     "sphinx-rtd-theme>=3.0.2",
     "sphinx_selective_exclude>=1.0.3",
     "sphinx-toolbox>=3.9.0",
-    "sphinxext.opengraph>=0.9.1",
+    "sphinxext.opengraph>=0.9.2",
     "swagger-plugin-for-sphinx>=5.1.0",
     "tomli>=2.1.0",
     "types-pyyaml>=6.0.12.20250402",
@@ -262,7 +262,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.9.1"
+current_version = "0.9.2"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"