oe-python-template 0.6.2__tar.gz → 0.6.5__tar.gz

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.6.1-1-gd572e52
+_commit: v0.6.4-1-gb0d74a6
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/CHANGELOG.md

@@ -1,6 +1,24 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.6.2](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.1..0.6.2) - 2025-03-17
+## [0.6.5](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.4..0.6.5) - 2025-03-17
+
+### 📚 Documentation
+
+- *(readme)* Typo - ([8e5f20b](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/8e5f20b5f76a5dceec6bd34a7cf6e002bee6183b))
+
+
+## [0.6.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.2..v0.6.4) - 2025-03-17
+
+### 🚜 Refactor
+
+- Dry - ([c427611](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/c4276118dfbef8c729011462550e1a2d565fe7b6))
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump - ([e5993ee](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/e5993eee24425279d2aed636c913d49b4aa0149a))
+
+
+## [0.6.2](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.1..v0.6.2) - 2025-03-17
 
 ### 📚 Documentation
 

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.6.2
+Version: 0.6.5
 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/
@@ -130,7 +130,7 @@ uv tool install copier                                # Install copier as global
 
 **Step 3**: Scaffold the project
 ```shell
-copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template . --trust
+copier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
 
 **Step 4**: Perform initial commit and push

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/README.md

@@ -69,7 +69,7 @@ uv tool install copier                                # Install copier as global
 
 **Step 3**: Scaffold the project
 ```shell
-copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template . --trust
+copier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
 
 **Step 4**: Perform initial commit and push

oe_python_template-0.6.5/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [0.6.5](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.4..v0.6.5) - 2025-03-17
+
+### 📚 Documentation
+
+- *(readme)* Typo - ([8e5f20b](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/8e5f20b5f76a5dceec6bd34a7cf6e002bee6183b))
+
+
+

oe_python_template-0.6.5/VERSION

@@ -0,0 +1 @@
+0.6.5

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/docs/partials/README_main.md

@@ -27,7 +27,7 @@ uv tool install copier                                # Install copier as global
 
 **Step 3**: Scaffold the project
 ```shell
-copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template . --trust
+copier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
 
 **Step 4**: Perform initial commit and push

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/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.2"
+version = "0.6.5"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template"

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/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-0.6.2 → oe_python_template-0.6.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.6.2"
+version = "0.6.5"
 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.2"
+current_version = "0.6.5"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/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.2
+sonar.projectVersion=0.6.5
 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.2 → oe_python_template-0.6.5}/src/oe_python_template/api.py

@@ -21,6 +21,9 @@ from oe_python_template 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"
 
 
 def get_service() -> Generator[Service, None, None]:
@@ -41,9 +44,9 @@ api = FastAPI(
     root_path="/api",
     title="OE Python Template",
     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.readthedocs.io/en/latest/",
     openapi_tags=[
@@ -70,9 +73,9 @@ api_v1 = FastAPI(
     version="1.0.0",
     title="OE Python Template",
     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.readthedocs.io/en/latest/",
 )
@@ -81,9 +84,9 @@ api_v2 = FastAPI(
     version="2.0.0",
     title="OE Python Template",
     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.readthedocs.io/en/latest/",
 )

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/template/docs/partials/README_main.md.jinja

@@ -27,7 +27,7 @@ uv tool install copier                                # Install copier as global
 
 **Step 3**: Scaffold the project
 ```shell
-copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template . --trust
+copier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
 
 **Step 4**: Perform initial commit and push

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/template/noxfile.py.jinja

@@ -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-0.6.2 → oe_python_template-0.6.5}/template/src/{{ project_name_snake_case }}/api.py.jinja

@@ -21,7 +21,9 @@ from {{ project_name_snake_case }} 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 = "{{ org_name }}"
+CONTACT_EMAIL = "{{ org_email }}"
+CONTACT_URL = "https://github.com/{{ github_repository_owner }}"
 
 def get_service() -> Generator[Service, None, None]:
     """Get the service instance.
@@ -41,9 +43,9 @@ api = FastAPI(
     root_path="/api",
     title="{{ project_name }}",
     contact={
-        "name": "{{ org_name }}",
-        "email": "{{ org_email }}",
-        "url": "https://github.com/{{ github_repository_owner }}",
+        "name": CONTACT_NAME,
+        "email": CONTACT_EMAIL,
+        "url": CONTACT_URL,
     },
     terms_of_service="https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/",
     openapi_tags=[
@@ -70,9 +72,9 @@ api_v1 = FastAPI(
     version="1.0.0",
     title="{{ project_name }}",
     contact={
-        "name": "{{ org_name }}",
-        "email": "{{ org_email }}",
-        "url": "https://github.com/{{ github_repository_owner }}",
+        "name": CONTACT_NAME,
+        "email": CONTACT_EMAIL,
+        "url": CONTACT_URL,
     },
     terms_of_service="https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/",
 )
@@ -81,9 +83,9 @@ api_v2 = FastAPI(
     version="2.0.0",
     title="{{ project_name }}",
     contact={
-        "name": "{{ org_name }}",
-        "email": "{{ org_email }}",
-        "url": "https://github.com/{{ github_repository_owner }}",
+        "name": CONTACT_NAME,
+        "email": CONTACT_EMAIL,
+        "url": CONTACT_URL,
     },
     terms_of_service="https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/",
 )

{oe_python_template-0.6.2 → oe_python_template-0.6.5}/template/tests/api_test.py.jinja

@@ -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-0.6.2 → oe_python_template-0.6.5}/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-0.6.2 → oe_python_template-0.6.5}/uv.lock

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

oe_python_template-0.6.2/RELEASE_NOTES.md

@@ -1,8 +0,0 @@
-## [0.6.2](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.1..v0.6.2) - 2025-03-17
-
-### 📚 Documentation
-
-- *(README)* Add --trust, and simplify by removing manual setup step - ([c4f5ec5](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/c4f5ec569007f852191029a16b9b6743ef0a5cee))
-
-
-

oe_python_template-0.6.2/VERSION

@@ -1 +0,0 @@
-0.6.2