oe-python-template-example 0.1.19__tar.gz → 0.2.1__tar.gz

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/.copier-answers.yml

@@ -1,8 +1,9 @@
-_commit: v0.5.14
+_commit: v0.6.12
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 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-example
 docker_io_owner: helmuthva
 github_repository_name: oe-python-template-example
@@ -16,6 +17,7 @@ project_description: Example project scaffolded and kept up to date with OE Pyth
 project_icon: 🧠
 project_name: OE Python Template Example
 pypi_distribution_name: oe-python-template-example
+readthedocs_domain: readthedocs.org
 readthedocs_project_key: oe-python-template-example
 sonarqube_key: helmut-hoffer-von-ankershoffen_oe-python-template-example
 streamlit_project_key: oe-python-template-example

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/.github/workflows/docker-image-build-publish.yml

@@ -5,6 +5,7 @@ on:
     tags:
       - "v*.*.*"
 
+
 env:
   REGISTRY: docker.io
   IMAGE_NAME: helmuthva/oe-python-template-example
@@ -28,25 +29,38 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
+
+
       - name: Log in to Docker Hub
         uses: docker/login-action@v3
         with:
+
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
+
+
       - name: Log in to GitHub container registry
         uses: docker/login-action@v3
         with:
           registry: ghcr.io
+
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
+
+
       - name: Extract metadata (tags, labels) for Docker
         id: meta
         uses: docker/metadata-action@v5
         with:
+
+
           images: |
             ${{ env.IMAGE_NAME }}
             ghcr.io/${{ github.repository }}
+
+
+
           tags: |
             # set latest tag for releases
             type=raw,value=latest
@@ -55,6 +69,8 @@ jobs:
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{major}}
 
+
+
       - name: Build and push Docker image
         id: push
         uses: docker/build-push-action@v6
@@ -66,6 +82,9 @@ jobs:
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
 
+
+
+
       - name: Generate artifact attestation
         uses: actions/attest-build-provenance@v2
         with:

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/CHANGELOG.md

@@ -1,5 +1,12 @@
 [🧠 OE Python Template Example](https://oe-python-template-example.readthedocs.io/en/latest/)
 
+## [0.2.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.1.19..v0.2.0) - 2025-03-16
+
+### ⛰️  Features
+
+- Code-style for humans and agents - ([c03b6d5](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/c03b6d5c12b4bc47bf206236a8363937177da040))
+
+
 ## [0.1.15](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.1.14..v0.1.15) - 2025-03-15
 
 ### ⚙️ Miscellaneous Tasks

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/CODE_STYLE.md

@@ -1,12 +1,9 @@
 # Code Style
 
-Author: Helmut Hoffer von Ankershoffen (@helmut-hoffer-von-ankershoffen )
-Status: Draft
-Created: 2025-03-16
-Updated: 2025-03-16
+Author: Helmut Hoffer von Ankershoffen (@helmut-hoffer-von-ankershoffen ) - Status: Draft - Created: 2025-03-16 - Updated: 2025-03-16
 
 This document describes the code style used in
-[oe-python-templat](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
+[oe-python-template](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
 and derivatives. It defines strict requirements to be followed by all
 contributors - humans and agents - to ensure consistency and readability across
 the codebase.

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.1.19
+Version: 0.2.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/

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/SERVICE_CONNECTIONS.md

@@ -27,6 +27,12 @@
 4. On https://app.readthedocs.org/projects/oe-python-template-example/ wait for the build of the documentation to finish
 5. Goto https://oe-python-template-example.readthedocs.io/en/latest/
 
+## Automatic dependency updates via Rennovate (https://github.com/apps/renovate)
+
+1. Goto https://github.com/apps/renovate and click the "Configure" button
+2. Select the owner of your project's repository and configure "Repository access"
+3. Rennovate creates a [Dependency Dashboard](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/issues) as an issue in your repository
+
 ## Publishing package to Python Package Index (pypi.org)
 
 1. Execute `uv build`. This will generate the build files (wheel and tar.gz) in the `dist` folder

oe_python_template_example-0.2.1/VERSION

@@ -0,0 +1 @@
+0.2.1

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/docs/source/conf.py

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

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/n

@@ -24,4 +24,4 @@ echo "Usage: ./n <session_name> [additional_args]"
     shift # Remove the first argument, remaining args will be passed through
 
     # Execute the command, forwarding all output
-    exec uv run nox -s "$session" "$@"
+    exec uv run nox -s "$session" -- "$@"

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/noxfile.py

@@ -191,7 +191,7 @@ def bump(session: nox.Session) -> None:
     version_part = session.posargs[0] if session.posargs else "patch"
 
     # Check if the version_part is a specific version (e.g., 1.2.3)
-    if re.match(r"^[0-9]+\.[0-9]+\.[0-9]+$", version_part):
+    if re.match(r"^\d+\.\d+\.\d+$", version_part):
         session.run("bump-my-version", "bump", "--new-version", version_part, external=True)
     else:
         session.run("bump-my-version", "bump", version_part, external=True)

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.1.19"
+version = "0.2.1"
 description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
 readme = "README.md"
 authors = [
@@ -242,7 +242,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.1.19"
+current_version = "0.2.1"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/sonar-project.properties

@@ -1,12 +1,12 @@
 sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template-example
 sonar.organization=helmut-hoffer-von-ankershoffen
-sonar.projectVersion=0.1.19
+sonar.projectVersion=0.2.1
 sonar.projectDescription=🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 sonar.links.homepage=https://oe-python-template-example.readthedocs.io/en/latest/
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example
 sonar.links.ci=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/actions
 sonar.links.issues=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/issues
-sonar.python.coverage.reportPaths=coverage.xml
+sonar.python.coverage.reportPaths=reports/coverage.xml
 sonar.python.version=3.11, 3.12, 3.13
 sonar.coverage.exclusions=noxfile.py, tests/**, examples/**, docs/**
 sonar.exclusions=examples/**, docs/**

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/src/oe_python_template_example/api.py

@@ -21,6 +21,10 @@ from oe_python_template_example import Service
 HELLO_WORLD_EXAMPLE = "Hello, world!"
 UVICORN_HOST = os.environ.get("UVICORN_HOST", "127.0.0.1")
 UVICORN_PORT = os.environ.get("UVICORN_PORT", "8000")
+CONTACT_NAME = "Helmut Hoffer von Ankershoffen"
+CONTACT_EMAIL = "helmuthva@gmail.com"
+CONTACT_URL = "https://github.com/helmut-hoffer-von-ankershoffen"
+TERMS_OF_SERVICE_URL = "https://oe-python-template-example.readthedocs.io/en/latest/"
 
 
 def get_service() -> Generator[Service, None, None]:
@@ -41,11 +45,11 @@ api = FastAPI(
     root_path="/api",
     title="OE Python Template Example",
     contact={
-        "name": "Helmut Hoffer von Ankershoffen",
-        "email": "helmuthva@gmail.com",
-        "url": "https://github.com/helmut-hoffer-von-ankershoffen",
+        "name": CONTACT_NAME,
+        "email": CONTACT_EMAIL,
+        "url": CONTACT_URL,
     },
-    terms_of_service="https://oe-python-template-example.readthedocs.io/en/latest/",
+    terms_of_service=TERMS_OF_SERVICE_URL,
     openapi_tags=[
         {
             "name": "v1",
@@ -70,22 +74,22 @@ api_v1 = FastAPI(
     version="1.0.0",
     title="OE Python Template Example",
     contact={
-        "name": "Helmut Hoffer von Ankershoffen",
-        "email": "helmuthva@gmail.com",
-        "url": "https://github.com/helmut-hoffer-von-ankershoffen",
+        "name": CONTACT_NAME,
+        "email": CONTACT_EMAIL,
+        "url": CONTACT_URL,
     },
-    terms_of_service="https://oe-python-template-example.readthedocs.io/en/latest/",
+    terms_of_service=TERMS_OF_SERVICE_URL,
 )
 
 api_v2 = FastAPI(
     version="2.0.0",
     title="OE Python Template Example",
     contact={
-        "name": "Helmut Hoffer von Ankershoffen",
-        "email": "helmuthva@gmail.com",
-        "url": "https://github.com/helmut-hoffer-von-ankershoffen",
+        "name": CONTACT_NAME,
+        "email": CONTACT_EMAIL,
+        "url": CONTACT_URL,
     },
-    terms_of_service="https://oe-python-template-example.readthedocs.io/en/latest/",
+    terms_of_service=TERMS_OF_SERVICE_URL,
 )
 
 

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/tests/api_test.py

@@ -19,6 +19,12 @@ HEALTH_PATH_V2 = "/api/v2/health"
 HEALTHZ_PATH_V1 = "/api/v1/healthz"
 HEALTHZ_PATH_V2 = "/api/v2/healthz"
 
+HELLO_WORLD = "Hello, world!"
+
+SERVICE_UP = "UP"
+SERVICE_DOWN = "DOWN"
+SERVICE_IS_UNHEALTHY = "Service is unhealthy"
+
 
 @pytest.fixture
 def client() -> TestClient:
@@ -37,11 +43,11 @@ def test_hello_world_endpoint(client: TestClient) -> None:
     """Test that the hello-world endpoint returns the expected message."""
     response = client.get(HELLO_WORLD_PATH_V1)
     assert response.status_code == 200
-    assert response.json()["message"].startswith("Hello, world!")
+    assert response.json()["message"].startswith(HELLO_WORLD)
 
     response = client.get(HELLO_WORLD_PATH_V2)
     assert response.status_code == 200
-    assert response.json()["message"].startswith("Hello, world!")
+    assert response.json()["message"].startswith(HELLO_WORLD)
 
 
 def test_echo_endpoint_valid_input(client: TestClient) -> None:
@@ -79,22 +85,22 @@ def test_health_endpoint(client: TestClient) -> None:
     """Test that the health endpoint returns UP status."""
     response = client.get(HEALTH_PATH_V1)
     assert response.status_code == 200
-    assert response.json()["status"] == "UP"
+    assert response.json()["status"] == SERVICE_UP
     assert response.json()["reason"] is None
 
     response = client.get(HEALTH_PATH_V2)
     assert response.status_code == 200
-    assert response.json()["status"] == "UP"
+    assert response.json()["status"] == SERVICE_UP
     assert response.json()["reason"] is None
 
     response = client.get(HEALTHZ_PATH_V1)
     assert response.status_code == 200
-    assert response.json()["status"] == "UP"
+    assert response.json()["status"] == SERVICE_UP
     assert response.json()["reason"] is None
 
     response = client.get(HEALTHZ_PATH_V2)
     assert response.status_code == 200
-    assert response.json()["status"] == "UP"
+    assert response.json()["status"] == SERVICE_UP
     assert response.json()["reason"] is None
 
 
@@ -107,20 +113,20 @@ def test_health_endpoint_down(mock_service, client: TestClient) -> None:
 
     response = client.get(HEALTH_PATH_V1)
     assert response.status_code == 500
-    assert response.json()["status"] == "DOWN"
-    assert response.json()["reason"] == "Service is unhealthy"
+    assert response.json()["status"] == SERVICE_DOWN
+    assert response.json()["reason"] == SERVICE_IS_UNHEALTHY
 
     response = client.get(HEALTH_PATH_V2)
     assert response.status_code == 500
-    assert response.json()["status"] == "DOWN"
-    assert response.json()["reason"] == "Service is unhealthy"
+    assert response.json()["status"] == SERVICE_DOWN
+    assert response.json()["reason"] == SERVICE_IS_UNHEALTHY
 
     response = client.get(HEALTHZ_PATH_V1)
     assert response.status_code == 500
-    assert response.json()["status"] == "DOWN"
-    assert response.json()["reason"] == "Service is unhealthy"
+    assert response.json()["status"] == SERVICE_DOWN
+    assert response.json()["reason"] == SERVICE_IS_UNHEALTHY
 
     response = client.get(HEALTHZ_PATH_V2)
     assert response.status_code == 500
-    assert response.json()["status"] == "DOWN"
-    assert response.json()["reason"] == "Service is unhealthy"
+    assert response.json()["status"] == SERVICE_DOWN
+    assert response.json()["reason"] == SERVICE_IS_UNHEALTHY

{oe_python_template_example-0.1.19 → oe_python_template_example-0.2.1}/uv.lock

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

oe_python_template_example-0.1.19/VERSION

@@ -1 +0,0 @@
-0.1.19