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

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

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

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

@@ -1,6 +1,13 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
-## [0.6.14](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.13..0.6.14) - 2025-03-18
+## [0.6.15](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.14..0.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))
+
+
+## [0.6.14](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.13..v0.6.14) - 2025-03-18
 
 ### 🚜 Refactor
 

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

@@ -131,12 +131,20 @@ docker run --env THE_VAR=THE_VALUE oe-python-template --help
 
 ### Copier
 
-Update scaffold from template
+Update from template
 
 ```shell
 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.14 → oe_python_template-0.6.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.6.14
+Version: 0.6.15
 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/
@@ -76,7 +76,7 @@ Description-Content-Type: text/markdown
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
 [![CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/codeql.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/code-scanning)
 [![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square&logo=dependabot)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/dependabot)
-[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
+[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard)
 [![Coverage](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template)
 [![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
 [![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/README.md

@@ -15,7 +15,7 @@
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
 [![CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/codeql.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/code-scanning)
 [![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square&logo=dependabot)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/dependabot)
-[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
+[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard)
 [![Coverage](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template)
 [![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
 [![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)

oe_python_template-0.6.15/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [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.14 → oe_python_template-0.6.15}/SECURITY.md

@@ -21,7 +21,7 @@ OE Python Template employs several automated tools to continuously monitor and i
 ### 1. Dependency Vulnerability Scanning
 
 - **GitHub Dependabot**: Monitors dependencies for known vulnerabilities and automatically creates pull requests to update them when security issues are found. [Dependendabot alerts](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/dependabot) published.
-- **Renovate Bot**: Automatically creates pull requests to update dependencies when new versions are available, with a focus on security patches. [Dependency Dashboard](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues) published.
+- **Renovate Bot**: Automatically creates pull requests to update dependencies when new versions are available, with a focus on security patches. [Dependency Dashboard](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard) published.
 - **pip-audit**: Regularly scans Python dependencies for known vulnerabilities using data from the Python Advisory Database. `vulnerabilities.json` published [per release](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases).
 
 ### 2. Dependency Compliance

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/SERVICE_CONNECTIONS.md

@@ -31,7 +31,7 @@
 
 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/issues) as an issue in your repository
+3. Rennovate creates a [Dependency Dashboard](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard) as an issue in your repository
 
 ## Publishing package to Python Package Index (pypi.org)
 

oe_python_template-0.6.15/VERSION

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

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/docs/partials/README_header.md

@@ -12,7 +12,7 @@
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template)
 [![CodeQL](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/codeql.yml/badge.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/code-scanning)
 [![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square&logo=dependabot)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/security/dependabot)
-[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
+[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard)
 [![Coverage](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template)
 [![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)
 [![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/noxfile.py)

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/docs/source/api_v1.rst

@@ -6,6 +6,10 @@ API V1
    .. swagger-plugin:: _static/openapi_v1.yaml
       :full-page:
 
+.. only:: singlehtml
+
+   Visit the `Interactive API Documentation <https://oe-python-template.readthedocs.io/en/latest/api_v1.html>`_
+
 .. only:: latex
 
    Visit the `Interactive API Documentation <https://oe-python-template.readthedocs.io/en/latest/api_v1.html>`_

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/docs/source/api_v2.rst

@@ -6,6 +6,10 @@ API V2
    .. swagger-plugin:: _static/openapi_v2.yaml
       :full-page:
 
+.. only:: singlehtml
+
+   Visit the `Interactive API Documentation <https://oe-python-template.readthedocs.io/en/latest/api_v2.html>`_
+
 .. only:: latex
 
    Visit the `Interactive API Documentation <https://oe-python-template.readthedocs.io/en/latest/api_v2.html>`_

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

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/docs/source/main.rst

@@ -1,2 +1 @@
 .. mdinclude:: ../partials/README_main.md
-:start-line: 0

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/n

@@ -16,6 +16,7 @@ echo "Usage: ./n <session_name> [additional_args]"
     echo " ./n bump minor"
     echo " ./n bump major"
     echo " ./n bump x.y.z"
+    echo " ./n docs_pdf"
     exit 1
     fi
 

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

@@ -78,6 +78,15 @@ def docs(session: nox.Session) -> None:
     # Build docs
     session.run("make", "-C", "docs", "clean", external=True)
     session.run("make", "-C", "docs", "html", external=True)
+    session.run("make", "-C", "docs", "singlehtml", external=True)
+    session.run("make", "-C", "docs", "latex", external=True)
+
+
+@nox.session(python=["3.13"], default=False)
+def docs_pdf(session: nox.Session) -> None:
+    """Setup dev environment post project creation."""
+    _setup_venv(session)
+    session.run("make", "-C", "docs", "latexpdf", external=True)
 
 
 @nox.session(python=["3.13"])

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

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

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/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.14
+sonar.projectVersion=0.6.15
 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.14 → oe_python_template-0.6.15}/template/CONTRIBUTING.md.jinja

@@ -131,12 +131,20 @@ docker run --env THE_VAR=THE_VALUE {{ pypi_distribution_name }} --help
 
 ### Copier
 
-Update scaffold from template
+Update from template
 
 ```shell
 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.14 → oe_python_template-0.6.15}/template/SECURITY.md.jinja

@@ -21,7 +21,7 @@ We currently provide security updates for the latest minor version.
 ### 1. Dependency Vulnerability Scanning
 
 - **GitHub Dependabot**: Monitors dependencies for known vulnerabilities and automatically creates pull requests to update them when security issues are found. [Dependendabot alerts]({{ github_repository_url_https }}/security/dependabot) published.
-- **Renovate Bot**: Automatically creates pull requests to update dependencies when new versions are available, with a focus on security patches. [Dependency Dashboard]({{ github_repository_url_https }}/issues) published.
+- **Renovate Bot**: Automatically creates pull requests to update dependencies when new versions are available, with a focus on security patches. [Dependency Dashboard]({{ github_repository_url_https }}/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard) published.
 - **pip-audit**: Regularly scans Python dependencies for known vulnerabilities using data from the Python Advisory Database. `vulnerabilities.json` published [per release]({{ github_repository_url_https }}/releases).
 
 ### 2. Dependency Compliance

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/template/SERVICE_CONNECTIONS.md.jinja

@@ -31,7 +31,7 @@
 
 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]({{ github_repository_url_https }}/issues) as an issue in your repository
+3. Rennovate creates a [Dependency Dashboard]({{ github_repository_url_https }}/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard) as an issue in your repository
 
 ## Publishing package to Python Package Index (pypi.org)
 

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/template/docs/partials/README_header.md.jinja

@@ -12,7 +12,7 @@
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project={{ sonarqube_key }}&metric=code_smells)](https://sonarcloud.io/summary/new_code?id={{ sonarqube_key }})
 [![CodeQL]({{ github_repository_url_https }}/actions/workflows/codeql.yml/badge.svg)]({{ github_repository_url_https }}/security/code-scanning)
 [![Dependabot](https://img.shields.io/badge/dependabot-active-brightgreen?style=flat-square&logo=dependabot)]({{ github_repository_url_https }}/security/dependabot)
-[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
+[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)]({{ github_repository_url_https }}/issues?q=is%3Aissue%20state%3Aopen%20Dependency%20Dashboard)
 [![Coverage](https://codecov.io/gh/{{ github_repository_owner }}/{{ github_repository_name }}/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/{{ github_repository_owner }}/{{ github_repository_name }})
 [![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)]({{ github_repository_url_https }}/blob/main/noxfile.py)
 [![MyPy](https://img.shields.io/badge/mypy-checked-blue)]({{ github_repository_url_https }}/blob/main/noxfile.py)

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/template/docs/source/api_v1.rst.jinja

@@ -6,6 +6,10 @@ API V1
    .. swagger-plugin:: _static/openapi_v1.yaml
       :full-page:
 
+.. only:: singlehtml
+
+   Visit the `Interactive API Documentation <https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/api_v1.html>`_
+
 .. only:: latex
 
    Visit the `Interactive API Documentation <https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/api_v1.html>`_

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/template/docs/source/api_v2.rst.jinja

@@ -6,6 +6,10 @@ API V2
    .. swagger-plugin:: _static/openapi_v2.yaml
       :full-page:
 
+.. only:: singlehtml
+
+   Visit the `Interactive API Documentation <https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/api_v2.html>`_
+
 .. only:: latex
 
    Visit the `Interactive API Documentation <https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/api_v2.html>`_

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/template/docs/source/main.rst.jinja

@@ -1,2 +1 @@
 .. mdinclude:: ../partials/README_main.md
-:start-line: 0

{oe_python_template-0.6.14 → oe_python_template-0.6.15}/template/n.jinja

@@ -16,6 +16,7 @@ echo "Usage: ./n <session_name> [additional_args]"
     echo " ./n bump minor"
     echo " ./n bump major"
     echo " ./n bump x.y.z"
+    echo " ./n docs_pdf"
     exit 1
     fi
 

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

@@ -78,6 +78,15 @@ def docs(session: nox.Session) -> None:
     # Build docs
     session.run("make", "-C", "docs", "clean", external=True)
     session.run("make", "-C", "docs", "html", external=True)
+    session.run("make", "-C", "docs", "singlehtml", external=True)
+    session.run("make", "-C", "docs", "latex", external=True)
+
+
+@nox.session(python=["3.13"], default=False)
+def docs_pdf(session: nox.Session) -> None:
+    """Setup dev environment post project creation."""
+    _setup_venv(session)
+    session.run("make", "-C", "docs", "latexpdf", external=True)
 
 
 @nox.session(python=["3.13"])

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

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

oe_python_template-0.6.14/RELEASE_NOTES.md

@@ -1,8 +0,0 @@
-## [0.6.14](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.6.13..v0.6.14) - 2025-03-18
-
-### 🚜 Refactor
-
-- *(api)* Fully dry - ([56e748f](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/56e748fab6e1cb3ae08f606b0aadb205e72ca353))
-
-
-

oe_python_template-0.6.14/VERSION

@@ -1 +0,0 @@
-0.6.14