oe-python-template-example 0.0.7__tar.gz → 0.0.8__tar.gz

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.3.0
+_commit: v0.3.6
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/.pre-commit-config.yaml

@@ -53,6 +53,7 @@ repos:
       - id: name-tests-test
       - id: requirements-txt-fixer
       - id: trailing-whitespace
+        exclude: "docs/source/_static"
   - repo: https://github.com/Yelp/detect-secrets
     rev: v1.5.0
     hooks:
@@ -60,8 +61,7 @@ repos:
         args: ['--baseline', '.secrets.baseline']
         additional_dependencies: ["gibberish-detector"]
   - repo: https://github.com/astral-sh/uv-pre-commit
-    # uv version.
-    rev: 0.5.8
+    rev: 0.6.5
     hooks:
       - id: uv-lock
   - repo: local

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/CHANGELOG.md

@@ -1,6 +1,6 @@
 [🧠 OE Python Template Example](https://oe-python-template-example.readthedocs.io/en/latest/)
 
-## [0.0.7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.4..0.0.7) - 2025-03-08
+## [0.0.7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.4..v0.0.7) - 2025-03-08
 
 ### ⚙️ Miscellaneous Tasks
 

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/CONTRIBUTING.md

@@ -119,7 +119,7 @@ Update scaffold from template
 copier update --trust --skip-tasks --skip-answered
 ```
 
-### Updating demo application contained within oe-python-template
+### Updating demo application contained within oe-python-template-example
 
 ```shell
 copier copy -r HEAD . . --force --trust

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.0.7
+Version: 0.0.8
 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/
@@ -48,6 +48,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: <4.0,>=3.11
+Requires-Dist: fastapi[all,standard]>=0.115.11
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: python-dotenv>=1.0.1
 Requires-Dist: typer>=0.15.1
@@ -127,7 +128,7 @@ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 Step 4: Setup the local environment
 
 ```shell
-uv run nox -s setup_eev
+uv run nox -s setup_dev
 ```
 
 Step 5: Perform inital commit and push
@@ -174,8 +175,8 @@ uvx oe-python-template-example
 The CLI provides extensive help:
 
 ```shell
-uvx oe-python-template-example --help              # all CLI commands
-uvx oe-python-template-example command --help      # all options for command
+uvx oe-python-template-example --help                # all CLI commands
+uvx oe-python-template-example hello-world --help    # help for specific command
 ```
 
 

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/README.md

@@ -67,7 +67,7 @@ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 Step 4: Setup the local environment
 
 ```shell
-uv run nox -s setup_eev
+uv run nox -s setup_dev
 ```
 
 Step 5: Perform inital commit and push
@@ -114,8 +114,8 @@ uvx oe-python-template-example
 The CLI provides extensive help:
 
 ```shell
-uvx oe-python-template-example --help              # all CLI commands
-uvx oe-python-template-example command --help      # all options for command
+uvx oe-python-template-example --help                # all CLI commands
+uvx oe-python-template-example hello-world --help    # help for specific command
 ```
 
 

oe_python_template_example-0.0.8/RELEASE_NOTES.md

@@ -0,0 +1 @@
+

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/SERVICE_CONNECTIONS.md

@@ -29,10 +29,10 @@
 
 ## Publishing package to Python Package Index (pypi.org)
 
-1. Execute `uv run build`. This will generate the build files (wheel and tar.gz) in the `dist` folder
+1. Execute `uv build`. This will generate the build files (wheel and tar.gz) in the `dist` folder
 2. Sign-Up at https://pypi.org/
 3. Goto https://pypi.org/manage/account/ and create an API token of scope "Entire account", calling it oe-python-template-example. Copy the value of the token into your clipboard.
-4. Execute `uv run publish`, entering __token__ as username and paste the token from your clipboard as password. This will register your package on PyPI and upload the build files
+4. Execute `uv publish`, entering __token__ as username and paste the token from your clipboard as password. This will register your package on PyPI and upload the build files
 5. Goto https://pypi.org/manage/account/ again and delete the previously created token oe-python-template-example of scope "Entire account".
 6. Now create an new API token, again called oe-python-template-example, but this time of scope "Project: oe-python-template-example". Copy the token into your clipboard.
 7. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings/secrets/actions/new and delete the previously created token.
@@ -60,3 +60,12 @@
 3. Goto https://share.streamlit.io/new and click "Deploy a public app from GitHub"
 4. Select the oe-python-template-example repo, for "Main file path" select `examples/streamlit.py`, for App URL enter `oe-python-template-example`.streamlit.app. Click "Deploy"
 5. Goto https://oe-python-template-example.streamlit.app
+
+## Polishing GitHub repository
+
+1. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example
+2. Click on the cogs icon in the top right corner next to about
+4. Copy oe-python-template-example.readthedocs.io into the website field
+3. Copy the description from the pyproject.toml file into the description field
+5. Copy up to 20 tags from the pyproject.toml file into the topics field
+6. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/settings and upload a soclial media image (e.g. logo.png) into the "Social preview" field

oe_python_template_example-0.0.8/VERSION

@@ -0,0 +1 @@
+0.0.8

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/_readme_main.md

@@ -32,7 +32,7 @@ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 Step 4: Setup the local environment
 
 ```shell
-uv run nox -s setup_eev
+uv run nox -s setup_dev
 ```
 
 Step 5: Perform inital commit and push
@@ -79,8 +79,8 @@ uvx oe-python-template-example
 The CLI provides extensive help:
 
 ```shell
-uvx oe-python-template-example --help              # all CLI commands
-uvx oe-python-template-example command --help      # all options for command
+uvx oe-python-template-example --help                # all CLI commands
+uvx oe-python-template-example hello-world --help    # help for specific command
 ```
 
 

oe_python_template_example-0.0.8/docs/source/_static/openapi.json

@@ -0,0 +1,185 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "OE Python Template Example",
+    "termsOfService": "https://oe-python-template-example.readthedocs.io/en/latest/",
+    "contact": {
+      "name": "Helmut Hoffer von Ankershoffen",
+      "url": "https://github.com/helmut-hoffer-von-ankershoffen",
+      "email": "helmuthva@gmail.com"
+    },
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/hello-world": {
+      "get": {
+        "tags": [
+          "Basics"
+        ],
+        "summary": "Hello World",
+        "description": "Return a hello world message.\n\nReturns:\n    HelloWorldResponse: A response containing the hello world message.",
+        "operationId": "hello_world_hello_world_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HelloWorldResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/echo": {
+      "post": {
+        "tags": [
+          "Basics"
+        ],
+        "summary": "Echo",
+        "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": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/EchoRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EchoResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "EchoRequest": {
+        "properties": {
+          "text": {
+            "type": "string",
+            "minLength": 1,
+            "title": "Text",
+            "description": "The text to echo back",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "text"
+        ],
+        "title": "EchoRequest",
+        "description": "Request model for echo endpoint."
+      },
+      "EchoResponse": {
+        "properties": {
+          "message": {
+            "type": "string",
+            "minLength": 1,
+            "title": "Message",
+            "description": "The message content",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "message"
+        ],
+        "title": "EchoResponse",
+        "description": "Response model for echo endpoint."
+      },
+      "HTTPValidationError": {
+        "properties": {
+          "detail": {
+            "items": {
+              "$ref": "#/components/schemas/ValidationError"
+            },
+            "type": "array",
+            "title": "Detail"
+          }
+        },
+        "type": "object",
+        "title": "HTTPValidationError"
+      },
+      "HelloWorldResponse": {
+        "properties": {
+          "message": {
+            "type": "string",
+            "title": "Message",
+            "description": "The hello world message",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "message"
+        ],
+        "title": "HelloWorldResponse",
+        "description": "Response model for hello-world endpoint."
+      },
+      "ValidationError": {
+        "properties": {
+          "loc": {
+            "items": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "integer"
+                }
+              ]
+            },
+            "type": "array",
+            "title": "Location"
+          },
+          "msg": {
+            "type": "string",
+            "title": "Message"
+          },
+          "type": {
+            "type": "string",
+            "title": "Error Type"
+          }
+        },
+        "type": "object",
+        "required": [
+          "loc",
+          "msg",
+          "type"
+        ],
+        "title": "ValidationError"
+      }
+    }
+  }
+}

oe_python_template_example-0.0.8/docs/source/_static/openapi.yaml

@@ -0,0 +1,131 @@
+components:
+  schemas:
+    EchoRequest:
+      description: Request model for echo endpoint.
+      properties:
+        text:
+          description: The text to echo back
+          examples:
+          - Hello, world!
+          minLength: 1
+          title: Text
+          type: string
+      required:
+      - text
+      title: EchoRequest
+      type: object
+    EchoResponse:
+      description: Response model for echo endpoint.
+      properties:
+        message:
+          description: The message content
+          examples:
+          - Hello, world!
+          minLength: 1
+          title: Message
+          type: string
+      required:
+      - message
+      title: EchoResponse
+      type: object
+    HTTPValidationError:
+      properties:
+        detail:
+          items:
+            $ref: '#/components/schemas/ValidationError'
+          title: Detail
+          type: array
+      title: HTTPValidationError
+      type: object
+    HelloWorldResponse:
+      description: Response model for hello-world endpoint.
+      properties:
+        message:
+          description: The hello world message
+          examples:
+          - Hello, world!
+          title: Message
+          type: string
+      required:
+      - message
+      title: HelloWorldResponse
+      type: object
+    ValidationError:
+      properties:
+        loc:
+          items:
+            anyOf:
+            - type: string
+            - type: integer
+          title: Location
+          type: array
+        msg:
+          title: Message
+          type: string
+        type:
+          title: Error Type
+          type: string
+      required:
+      - loc
+      - msg
+      - type
+      title: ValidationError
+      type: object
+info:
+  contact:
+    email: helmuthva@gmail.com
+    name: Helmut Hoffer von Ankershoffen
+    url: https://github.com/helmut-hoffer-von-ankershoffen
+  termsOfService: https://oe-python-template-example.readthedocs.io/en/latest/
+  title: OE Python Template Example
+  version: 1.0.0
+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\
+        \ Entity: If text is not provided or empty."
+      operationId: echo_echo_post
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/EchoRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EchoResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      summary: Echo
+      tags:
+      - Basics
+  /hello-world:
+    get:
+      description: "Return a hello world message.\n\nReturns:\n    
+HelloWorldResponse:\
+        \ A response containing the hello world message."
+      operationId: hello_world_hello_world_get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HelloWorldResponse'
+          description: Successful Response
+      summary: Hello World
+      tags:
+      - Basics

oe_python_template_example-0.0.8/docs/source/api.rst

@@ -0,0 +1,5 @@
+API
+===
+
+.. swagger-plugin:: _static/openapi.yaml
+    :full-page:

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/docs/source/conf.py

@@ -20,12 +20,13 @@ extensions = [
     "sphinx_inline_tabs",
     "sphinx_mdinclude",
     "sphinxext.opengraph",
+    "swagger_plugin_for_sphinx",  # https://github.com/SAP/swagger-plugin-for-sphinx?tab=readme-ov-file
 ]
 
 project = "oe-python-template-example"
 author = "Helmut Hoffer von Ankershoffen"
 copyright = f" (c) 2025-{datetime.now(UTC).year}, {author}"  # noqa: A001
-version = "0.0.7"
+version = "0.0.8"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template-example"

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/docs/source/index.rst

@@ -11,6 +11,7 @@
    :maxdepth: 2
 
    main
+   api
    reference
    release-notes
    contributing

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/noxfile.py

@@ -9,6 +9,8 @@ import nox
 nox.options.reuse_existing_virtualenvs = True
 nox.options.default_venv_backend = "uv"
 
+NOT_SKIP_WITH_ACT = "not skip_with_act"
+
 
 def _setup_venv(session: nox.Session, all_extras: bool = True) -> None:
     """Install dependencies for the given session using uv."""
@@ -57,7 +59,13 @@ def docs(session: nox.Session) -> None:
     footer = Path("_readme_footer.md").read_text(encoding="utf-8")
     readme_content = f"{header}\n\n{main}\n\n{footer}"
     Path("README.md").write_text(readme_content, encoding="utf-8")
+    # Dump openapi schema to file
+    with Path("docs/source/_static/openapi.yaml").open("w", encoding="utf-8") as f:
+        session.run("oe-python-template-example", "openapi", stdout=f, external=True)
+    with Path("docs/source/_static/openapi.json").open("w", encoding="utf-8") as f:
+        session.run("oe-python-template-example", "openapi", "--output-format=json", stdout=f, external=True)
     # Build docs
+    session.run("make", "-C", "docs", "clean", external=True)
     session.run("make", "-C", "docs", "html", external=True)
 
 
@@ -98,7 +106,7 @@ def test(session: nox.Session) -> None:
     _setup_venv(session)
     pytest_args = ["pytest", "--disable-warnings", "--junitxml=junit.xml", "-n", "auto", "--dist", "loadgroup"]
     if _is_act_environment():
-        pytest_args.extend(["-k", "not skip_with_act"])
+        pytest_args.extend(["-k", NOT_SKIP_WITH_ACT])
     session.run(*pytest_args)
 
 

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.0.7"
+version = "0.0.8"
 description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
 readme = "README.md"
 authors = [
@@ -59,12 +59,13 @@ classifiers = [
     "Natural Language :: English",
 ]
 
-requires-python = ">= 3.11, < 4.0"
+requires-python = ">=3.11, <4.0"
 
 dependencies = [
-    "pydantic >= 2.10.6",
-    "python-dotenv >= 1.0.1",
-    "typer >= 0.15.1",
+    "fastapi[standard,all]>=0.115.11",
+    "pydantic>=2.10.6",
+    "python-dotenv>=1.0.1",
+    "typer>=0.15.1",
 ]
 
 [project.scripts]
@@ -83,47 +84,48 @@ build-backend = "hatchling.build"
 
 [project.optional-dependencies]
 examples = [
-    "streamlit >= 1.43.1",
-    "marimo >= 0.11.17",
-    "jupyter >= 1.1.1",
-    "jinja2 >=3.1.6",
+    "streamlit>=1.43.1",
+    "marimo>=0.11.17",
+    "jupyter>=1.1.1",
+    "jinja2>=3.1.6",
 ]
 
 [dependency-groups]
 dev = [
-    "autodoc-pydantic >= 2.2.0",
-    "bump-my-version >= 1.0.1",
-    "cyclonedx-py >= 1.0.1",
-    "detect-secrets >= 1.5.0",
-    "enum-tools >= 0.12.0",
-    "furo >= 2024.8.6",
-    "git-cliff >= 2.8.0",
-    "mypy >= 1.5.0",
-    "nox[uv] >= 2025.2.9",
-    "pip-audit >= 2.8.0",
-    "pip-licenses >= 5.0.0",
-    "pre-commit >= 4.1.0",
-    "pyright >= 1.1.396",
-    "pytest >= 8.3.5",
-    "pytest-asyncio >= 0.25.3",
-    "pytest-cov >= 6.0.0",
-    "pytest-docker >= 3.2.0",
-    "pytest-env >= 1.1.5",
-    "pytest-xdist[psutil] >= 3.6.1",
-    "ruff >= 0.9.10",
-    "sphinx >= 8.2.3",
-    "sphinx-autobuild >= 2024.10.3",
-    "sphinx-copybutton >= 0.5.2",
-    "sphinx-inline-tabs >= 2023.4.21",
-    "sphinx-mdinclude >= 0.6.2",
-    "sphinxext.opengraph >= 0.9.1",
-    "sphinx-pydantic >= 0.1.1",
-    "sphinx-rtd-theme >= 3.0.2",
-    "sphinx-toolbox >= 3.9.0",
-    "sphinxext-opengraph >= 0.9.1",
-    "tomli >= 2.1.0",
-    "matplotlib >= 3.10.1",
-    "pytest-regressions >= 2.7.0",
+    "autodoc-pydantic>=2.2.0",
+    "bump-my-version>=1.0.2",
+    "cyclonedx-py>=1.0.1",
+    "detect-secrets>=1.5.0",
+    "enum-tools>=0.12.0",
+    "furo>=2024.8.6",
+    "git-cliff>=2.8.0",
+    "matplotlib>=3.10.1",
+    "mypy>=1.5.0",
+    "nox[uv]>=2025.2.9",
+    "pip-audit>=2.8.0",
+    "pip-licenses>=5.0.0",
+    "pre-commit>=4.1.0",
+    "pyright>=1.1.396",
+    "pytest>=8.3.5",
+    "pytest-asyncio>=0.25.3",
+    "pytest-cov>=6.0.0",
+    "pytest-docker>=3.2.0",
+    "pytest-env>=1.1.5",
+    "pytest-regressions>=2.7.0",
+    "pytest-xdist[psutil]>=3.6.1",
+    "ruff>=0.9.10",
+    "sphinx>=8.2.3",
+    "sphinx-autobuild>=2024.10.3",
+    "sphinx-copybutton>=0.5.2",
+    "sphinx-inline-tabs>=2023.4.21",
+    "sphinx-mdinclude>=0.6.2",
+    "sphinx-pydantic>=0.1.1",
+    "sphinx-rtd-theme>=3.0.2",
+    "sphinx-toolbox>=3.9.0",
+    "sphinxext.opengraph>=0.9.1",
+    "swagger-plugin-for-sphinx>=5.1.0",
+    "tomli>=2.1.0",
+    "types-pyyaml>=6.0.12.20241230",
 ]
 
 [tool.ruff]
@@ -242,7 +244,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.0.7"
+current_version = "0.0.8"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template_example-0.0.7 → oe_python_template_example-0.0.8}/sonar-project.properties

@@ -1,6 +1,6 @@
 sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template-example
 sonar.organization=helmut-hoffer-von-ankershoffen
-sonar.projectVersion=0.0.7
+sonar.projectVersion=0.0.8
 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