oe-python-template 0.6.15__tar.gz → 0.6.17__tar.gz

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.6.14-1-g6f04954
+_commit: v0.6.16-1-g0e35063
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/.github/workflows/codeql.yml

@@ -76,7 +76,7 @@ jobs:
           # Prefix the list here with "+" to use these queries and those in the config file.
 
           # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-          # queries: security-extended,security-and-quality
+          queries: security-extended,security-and-quality
 
       # If the analyze step fails for one of the languages you are analyzing with
       # "We were unable to automatically build your code", modify the matrix above

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/CHANGELOG.md

@@ -1,6 +1,20 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.6.15](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.14..0.6.15) - 2025-03-18
+## [0.6.17](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.16..0.6.17) - 2025-03-18
+
+### ⛰️  Features
+
+- *(docs_pdf)* Check for latex tooling - ([3c35f28](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/3c35f280652557650e4aa40c8b459ed42c536a65))
+
+
+## [0.6.16](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.15..v0.6.16) - 2025-03-18
+
+### ⛰️  Features
+
+- *(codeql)* Enable security-extended and security-and-quality - ([0dead53](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/0dead53a748967132eb80f570b44d038a88788e5))
+
+
+## [0.6.15](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.14..v0.6.15) - 2025-03-18
 
 ### ⚙️ Miscellaneous Tasks
 

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/CONTRIBUTING.md

@@ -88,9 +88,10 @@ uv run nox -s test      # run tests
 uv run nox -s lint      # run formatting and linting
 uv run nox -s audit     # run security and license audit, inc. sbom generation
 uv run nox -s docs      # build documentation, output in docs/build/html
+uv run nox -s docs_pdf  # locally build pdf manual to docs/build/latex/oe-python-template.pdf
 ```
 
-As a shortcut, you can run build steps using `./n`:
+As a shortcut, you can run build steps using `./n`, e.g.
 
 ```shell
 ./n test
@@ -137,14 +138,6 @@ Update from template
 uv run nox -s update_from_template
 ```
 
-### Generate PDF manual
-
-```shell
-brew install mactex # install MacTeX, will take a while and requires sudo
-./n docs_pdf        # build latex, then generate pdf from it. Output in docs/build/latex/oe-python-template.pdf
-```
-
-
 ## Pull Request Guidelines
 
 - Before starting to write code read the [code style guide](CODE_STYLE.md) document for mandatory coding style

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.6.15
+Version: 0.6.17
 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.17/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [0.6.17](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.16..v0.6.17) - 2025-03-18
+
+### ⛰️  Features
+
+- *(docs_pdf)* Check for latex tooling - ([3c35f28](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/3c35f280652557650e4aa40c8b459ed42c536a65))
+
+
+

oe_python_template-0.6.17/VERSION

@@ -0,0 +1 @@
+0.6.17

oe_python_template-0.6.17/docs/source/_static/openapi_v1.yaml

@@ -0,0 +1,36 @@
+Traceback (most recent call last):
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/bin/oe-python-template", line 4, in <module>
+    from oe_python_template.cli import cli
+  File "/Users/helmut/Code/oe-python-template/src/oe_python_template/cli.py", line 7, in <module>
+    import typer
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/typer/__init__.py", line 29, in <module>
+    from .main import Typer as Typer
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/typer/main.py", line 21, in <module>
+    from .core import (
+    ...<6 lines>...
+    )
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/typer/core.py", line 36, in <module>
+    from . import rich_utils
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/typer/rich_utils.py", line 14, in <module>
+    from rich.columns import Columns
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/rich/columns.py", line 7, in <module>
+    from .console import Console, ConsoleOptions, RenderableType, RenderResult
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/rich/console.py", line 59, in <module>
+    from .pretty import Pretty, is_expandable
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/rich/pretty.py", line 33, in <module>
+    import attr as _attr_module
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/attr/__init__.py", line 10, in <module>
+    from . import converters, exceptions, filters, setters, validators
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/attr/converters.py", line 10, in <module>
+    from ._make import NOTHING, Converter, Factory, pipe
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/attr/_make.py", line 21, in <module>
+    from . import _compat, _config, setters
+  File "/Users/helmut/Code/oe-python-template/.nox/docs-3-13/lib/python3.13/site-packages/attr/setters.py", line 8, in <module>
+    from .exceptions import FrozenAttributeError
+  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
+  File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
+  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
+  File "<frozen importlib._bootstrap_external>", line 1022, in exec_module
+  File "<frozen importlib._bootstrap_external>", line 1118, in get_code
+  File "<frozen importlib._bootstrap_external>", line 1218, in get_data
+KeyboardInterrupt

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

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/noxfile.py

@@ -7,11 +7,13 @@ from pathlib import Path
 
 import nox
 import tomli
+from nox.command import CommandFailed
 
 nox.options.reuse_existing_virtualenvs = True
 nox.options.default_venv_backend = "uv"
 
 NOT_SKIP_WITH_ACT = "not skip_with_act"
+LATEXMK_VERSION_MIN = 4.86
 
 
 def _setup_venv(session: nox.Session, all_extras: bool = True) -> None:
@@ -84,9 +86,33 @@ def docs(session: nox.Session) -> None:
 
 @nox.session(python=["3.13"], default=False)
 def docs_pdf(session: nox.Session) -> None:
-    """Setup dev environment post project creation."""
+    """Setup dev environment post project creation."""  # noqa: DOC501
     _setup_venv(session)
-    session.run("make", "-C", "docs", "latexpdf", external=True)
+    try:
+        out = session.run("latexmk", "--version", external=True, silent=True)
+
+        version_match = re.search(r"Version (\d+\.\d+\w*)", str(out))
+        if not version_match:
+            session.error("Could not determine latexmk version")
+
+        version_str = version_match.group(1)
+
+        # Parse version (handle cases like "4.86a")
+        match = re.match(r"(\d+\.\d+)", version_str)
+        if not match:
+            session.error(f"Could not parse version number from '{version_str}'")
+        base_version = match.group(1)
+
+        if float(base_version) < LATEXMK_VERSION_MIN:
+            message = f"latexmk version {version_str} is outdated. Please run 'brew upgrade mactex' to upgrade."
+            raise ValueError(message)  # noqa: TRY301
+        session.log(f"latexmk version {version_str} is sufficient")
+        session.run("make", "-C", "docs", "latexpdf", external=True)
+
+    except CommandFailed as e:
+        session.error(f"latexmk is not installed or not in PATH: {e}. Please run 'brew install mactex' to install")
+    except (ValueError, AttributeError) as e:
+        session.error(f"Failed to parse latexmk version information: {e}")
 
 
 @nox.session(python=["3.13"])

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/pyproject.toml

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

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/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.15
+sonar.projectVersion=0.6.17
 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.15 → oe_python_template-0.6.17}/template/.github/workflows/codeql.yml

@@ -76,7 +76,7 @@ jobs:
           # Prefix the list here with "+" to use these queries and those in the config file.
 
           # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-          # queries: security-extended,security-and-quality
+          queries: security-extended,security-and-quality
 
       # If the analyze step fails for one of the languages you are analyzing with
       # "We were unable to automatically build your code", modify the matrix above

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/template/CONTRIBUTING.md.jinja

@@ -88,9 +88,10 @@ uv run nox -s test      # run tests
 uv run nox -s lint      # run formatting and linting
 uv run nox -s audit     # run security and license audit, inc. sbom generation
 uv run nox -s docs      # build documentation, output in docs/build/html
+uv run nox -s docs_pdf  # locally build pdf manual to docs/build/latex/{{ pypi_distribution_name }}.pdf
 ```
 
-As a shortcut, you can run build steps using `./n`:
+As a shortcut, you can run build steps using `./n`, e.g.
 
 ```shell
 ./n test
@@ -137,14 +138,6 @@ Update from template
 uv run nox -s update_from_template
 ```
 
-### Generate PDF manual
-
-```shell
-brew install mactex # install MacTeX, will take a while and requires sudo
-./n docs_pdf        # build latex, then generate pdf from it. Output in docs/build/latex/{{ pypi_distribution_name }}.pdf
-```
-
-
 ## Pull Request Guidelines
 
 - Before starting to write code read the [code style guide](CODE_STYLE.md) document for mandatory coding style

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/template/noxfile.py.jinja

@@ -7,11 +7,13 @@ from pathlib import Path
 
 import nox
 import tomli
+from nox.command import CommandFailed
 
 nox.options.reuse_existing_virtualenvs = True
 nox.options.default_venv_backend = "uv"
 
 NOT_SKIP_WITH_ACT = "not skip_with_act"
+LATEXMK_VERSION_MIN = 4.86
 
 
 def _setup_venv(session: nox.Session, all_extras: bool = True) -> None:
@@ -84,9 +86,33 @@ def docs(session: nox.Session) -> None:
 
 @nox.session(python=["3.13"], default=False)
 def docs_pdf(session: nox.Session) -> None:
-    """Setup dev environment post project creation."""
+    """Setup dev environment post project creation."""  # noqa: DOC501
     _setup_venv(session)
-    session.run("make", "-C", "docs", "latexpdf", external=True)
+    try:
+        out = session.run("latexmk", "--version", external=True, silent=True)
+
+        version_match = re.search(r"Version (\d+\.\d+\w*)", str(out))
+        if not version_match:
+            session.error("Could not determine latexmk version")
+
+        version_str = version_match.group(1)
+
+        # Parse version (handle cases like "4.86a")
+        match = re.match(r"(\d+\.\d+)", version_str)
+        if not match:
+            session.error(f"Could not parse version number from '{version_str}'")
+        base_version = match.group(1)
+
+        if float(base_version) < LATEXMK_VERSION_MIN:
+            message = f"latexmk version {version_str} is outdated. Please run 'brew upgrade mactex' to upgrade."
+            raise ValueError(message)  # noqa: TRY301
+        session.log(f"latexmk version {version_str} is sufficient")
+        session.run("make", "-C", "docs", "latexpdf", external=True)
+
+    except CommandFailed as e:
+        session.error(f"latexmk is not installed or not in PATH: {e}. Please run 'brew install mactex' to install")
+    except (ValueError, AttributeError) as e:
+        session.error(f"Failed to parse latexmk version information: {e}")
 
 
 @nox.session(python=["3.13"])

{oe_python_template-0.6.15 → oe_python_template-0.6.17}/uv.lock

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

oe_python_template-0.6.15/RELEASE_NOTES.md

@@ -1,8 +0,0 @@
-## [0.6.15](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.14..v0.6.15) - 2025-03-18
-
-### ⚙️ Miscellaneous Tasks
-
-- *(docs)* Generate singlehtml and pdf; deeper rennovate link - ([14fe3c0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/14fe3c07e45daee42716c7d09fcbeb6aae02c9a7))
-
-
-

oe_python_template-0.6.15/VERSION

@@ -1 +0,0 @@
-0.6.15

oe_python_template-0.6.15/docs/source/_static/openapi_v1.yaml

@@ -1,188 +0,0 @@
-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
-    Health:
-      description: Health status model.
-      properties:
-        reason:
-          anyOf:
-          - type: string
-          - type: 'null'
-          title: Reason
-        status:
-          $ref: '#/components/schemas/_HealthStatus'
-      required:
-      - status
-      title: Health
-      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
-    _HealthStatus:
-      description: Health status enumeration.
-      enum:
-      - UP
-      - DOWN
-      title: _HealthStatus
-      type: string
-info:
-  contact:
-    email: helmuthva@gmail.com
-    name: Helmut Hoffer von Ankershoffen
-    url: https://github.com/helmut-hoffer-von-ankershoffen
-  termsOfService: https://oe-python-template.readthedocs.io/en/latest/
-  title: OE Python Template
-  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
-  /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:\
-        \ The health status of the service."
-      operationId: health_health_get
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Health'
-          description: Successful Response
-      summary: Health
-      tags:
-      - 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:\
-        \ The health status of the service."
-      operationId: health_healthz_get
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Health'
-          description: Successful Response
-      summary: Health
-      tags:
-      - Observability
-  /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