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

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

@@ -1,4 +1,4 @@
-_commit: v0.6.4-1-gb0d74a6
+_commit: v0.6.6-1-g3894b2a
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen
@@ -16,6 +16,7 @@ project_description: Copier template to scaffold Python projects compliant with
 project_icon: 🧠
 project_name: OE Python Template
 pypi_distribution_name: oe-python-template
+readthedocs_domain: readthedocs.org
 readthedocs_project_key: oe-python-template
 sonarqube_key: helmut-hoffer-von-ankershoffen_oe-python-template
 streamlit_project_key: oe-python-template

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

@@ -1,6 +1,20 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.6.5](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.4..0.6.5) - 2025-03-17
+## [0.6.7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.6..0.6.7) - 2025-03-17
+
+### Enh
+
+- *(rtd)* Support business edition - ([650b1cb](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/650b1cb0a1bccb57159a65eb1f28c2ae9f625340))
+
+
+## [0.6.6](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.5..v0.6.6) - 2025-03-17
+
+### 🚜 Refactor
+
+- *(api)* Dry - ([295ff4d](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/295ff4d1f456f85d04f96a9941de4bdb923de9a4))
+
+
+## [0.6.5](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.4..v0.6.5) - 2025-03-17
 
 ### 📚 Documentation
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.6.5
+Version: 0.6.7
 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/

oe_python_template-0.6.7/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [0.6.7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.6..v0.6.7) - 2025-03-17
+
+### Enh
+
+- *(rtd)* Support business edition - ([650b1cb](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/650b1cb0a1bccb57159a65eb1f28c2ae9f625340))
+
+
+

oe_python_template-0.6.7/VERSION

@@ -0,0 +1 @@
+0.6.7

{oe_python_template-0.6.5 → oe_python_template-0.6.7}/copier.yml

@@ -151,6 +151,14 @@ pypi_distribution_name:
     Invalid PyPi distribution name
     {% endif %}
 
+readthedocs_domain:
+  type: str
+  help: What is the domain name of the Read The Docs instance? Use readthedocs.org for the community edition and readthedocs.com for the business edition.
+  choices:
+    readthedocs.org
+    readthedocs.com
+  default: readthedocs.org
+
 readthedocs_project_key:
   type: str
   help: What is the key of the project at Read The Docs (about.readthedocs.com)? You likely want to accept the default.

{oe_python_template-0.6.5 → oe_python_template-0.6.7}/docs/source/_static/openapi_v1.yaml

@@ -104,9 +104,12 @@ 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\
+      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:
@@ -133,12 +136,18 @@ paths:
       - 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:\
+      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:
@@ -153,12 +162,18 @@ paths:
       - 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:\
+      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:
@@ -173,7 +188,8 @@ paths:
       - Observability
   /hello-world:
     get:
-      description: "Return a hello world message.\n\nReturns:\n    HelloWorldResponse:\
+      description: "Return a hello world message.\n\nReturns:\n    
+HelloWorldResponse:\
         \ A response containing the hello world message."
       operationId: hello_world_hello_world_get
       responses:

{oe_python_template-0.6.5 → oe_python_template-0.6.7}/docs/source/_static/openapi_v2.yaml

@@ -104,9 +104,12 @@ openapi: 3.1.0
 paths:
   /echo:
     post:
-      description: "Echo back the provided utterance.\n\nArgs:\n    request (Utterance):\
-        \ The request containing the utterance to echo back.\n\nReturns:\n    EchoResponse:\
-        \ A response containing the echoed utterance.\n\nRaises:\n    422 Unprocessable\
+      description: "Echo back the provided utterance.\n\nArgs:\n    request 
+(Utterance):\
+        \ The request containing the utterance to echo back.\n\nReturns:\n    
+EchoResponse:\
+        \ A response containing the echoed utterance.\n\nRaises:\n    422 
+Unprocessable\
         \ Entity: If utterance is not provided or empty."
       operationId: echo_v2_echo_post
       requestBody:
@@ -133,12 +136,18 @@ paths:
       - 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:\
+      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:
@@ -153,12 +162,18 @@ paths:
       - 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:\
+      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:
@@ -173,7 +188,8 @@ paths:
       - Observability
   /hello-world:
     get:
-      description: "Return a hello world message.\n\nReturns:\n    HelloWorldResponse:\
+      description: "Return a hello world message.\n\nReturns:\n    
+HelloWorldResponse:\
         \ A response containing the hello world message."
       operationId: hello_world_hello_world_get
       responses:

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

{oe_python_template-0.6.5 → oe_python_template-0.6.7}/pyproject.toml

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

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

@@ -24,6 +24,7 @@ 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.readthedocs.io/en/latest/"
 
 
 def get_service() -> Generator[Service, None, None]:
@@ -48,7 +49,7 @@ api = FastAPI(
         "email": CONTACT_EMAIL,
         "url": CONTACT_URL,
     },
-    terms_of_service="https://oe-python-template.readthedocs.io/en/latest/",
+    terms_of_service=TERMS_OF_SERVICE_URL,
     openapi_tags=[
         {
             "name": "v1",
@@ -77,7 +78,7 @@ api_v1 = FastAPI(
         "email": CONTACT_EMAIL,
         "url": CONTACT_URL,
     },
-    terms_of_service="https://oe-python-template.readthedocs.io/en/latest/",
+    terms_of_service=TERMS_OF_SERVICE_URL,
 )
 
 api_v2 = FastAPI(
@@ -88,7 +89,7 @@ api_v2 = FastAPI(
         "email": CONTACT_EMAIL,
         "url": CONTACT_URL,
     },
-    terms_of_service="https://oe-python-template.readthedocs.io/en/latest/",
+    terms_of_service=TERMS_OF_SERVICE_URL,
 )
 
 

{oe_python_template-0.6.5 → oe_python_template-0.6.7}/template/SERVICE_CONNECTIONS.md.jinja

@@ -19,12 +19,12 @@
 7. Goto https://sonarcloud.io/project/settings?id={{ sonarqube_key }} and select "Quality Gate" in the left menu. Select "Sonar way" as default quality gate.
 8. Re-run the `CI / test` GitHub job in case you tried before and it failed as SonarQube was not yet wired up
 
-## Generating and publishing documentation via ReadTheDocs (readthedocs.org)
+## Generating and publishing documentation via ReadTheDocs ({{ readthedocs_domain }})
 
-1. Sign-Up at https://readthedocs.org/
-2. Goto https://app.readthedocs.org/dashboard/import/ and search for your repo by enterin {{ github_repository_name}} in the search bar
+1. Sign-Up at https://{{ readthedocs_domain }}/
+2. Goto https://app.{{ readthedocs_domain }}/dashboard/import/ and search for your repo by enterin {{ github_repository_name}} in the search bar
 3. Select the repo and click Continue, then Next.
-4. On https://app.readthedocs.org/projects/{{ github_repository_name }}/ wait for the build of the documentation to finish
+4. On https://app.{{ readthedocs_domain }}/projects/{{ github_repository_name }}/ wait for the build of the documentation to finish
 5. Goto https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/
 
 ## Publishing package to Python Package Index (pypi.org)

{oe_python_template-0.6.5 → oe_python_template-0.6.7}/template/src/{{ project_name_snake_case }}/api.py.jinja

@@ -24,6 +24,8 @@ UVICORN_PORT = os.environ.get("UVICORN_PORT", "8000")
 CONTACT_NAME = "{{ org_name }}"
 CONTACT_EMAIL = "{{ org_email }}"
 CONTACT_URL = "https://github.com/{{ github_repository_owner }}"
+TERMS_OF_SERVICE_URL = "https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/"
+
 
 def get_service() -> Generator[Service, None, None]:
     """Get the service instance.
@@ -47,7 +49,7 @@ api = FastAPI(
         "email": CONTACT_EMAIL,
         "url": CONTACT_URL,
     },
-    terms_of_service="https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/",
+    terms_of_service=TERMS_OF_SERVICE_URL,
     openapi_tags=[
         {
             "name": "v1",
@@ -76,7 +78,7 @@ api_v1 = FastAPI(
         "email": CONTACT_EMAIL,
         "url": CONTACT_URL,
     },
-    terms_of_service="https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/",
+    terms_of_service=TERMS_OF_SERVICE_URL,
 )
 
 api_v2 = FastAPI(
@@ -87,7 +89,7 @@ api_v2 = FastAPI(
         "email": CONTACT_EMAIL,
         "url": CONTACT_URL,
     },
-    terms_of_service="https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/",
+    terms_of_service=TERMS_OF_SERVICE_URL,
 )
 
 

{oe_python_template-0.6.5 → oe_python_template-0.6.7}/uv.lock

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

oe_python_template-0.6.5/RELEASE_NOTES.md

@@ -1,8 +0,0 @@
-## [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

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