oe-python-template 0.1.1__tar.gz → 0.1.2__tar.gz

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.1.0
+_commit: v0.1.1
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

oe_python_template-0.1.1/RELEASE_NOTES.md → oe_python_template-0.1.2/CHANGELOG.md

@@ -1,5 +1,12 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/)
 
+## [0.1.2](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.1..0.1.2) - 2025-03-02
+
+### 📚 Documentation
+
+- On template - ([48bdcbe](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/48bdcbe863942bc7dd03bc8e71a50cae968c010c))
+
+
 ## [0.1.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.0..v0.1.1) - 2025-03-02
 
 ### ⚙️ Miscellaneous Tasks

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.1.1
+Version: 0.1.2
 Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 Project-URL: Homepage, https://oe-python-template.readthedocs.io/
 Project-URL: Documentation, https://oe-python-template.readthedocs.io/

oe_python_template-0.1.1/CHANGELOG.md → oe_python_template-0.1.2/RELEASE_NOTES.md

@@ -1,6 +1,13 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/)
 
-## [0.1.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.0..0.1.1) - 2025-03-02
+## [0.1.2](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.1..v0.1.2) - 2025-03-02
+
+### 📚 Documentation
+
+- On template - ([48bdcbe](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/48bdcbe863942bc7dd03bc8e71a50cae968c010c))
+
+
+## [0.1.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.0..v0.1.1) - 2025-03-02
 
 ### ⚙️ Miscellaneous Tasks
 

oe_python_template-0.1.2/VERSION

@@ -0,0 +1 @@
+0.1.2

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/docs/source/conf.py

@@ -25,7 +25,7 @@ extensions = [
 project = "oe-python-template"
 author = "Helmut Hoffer von Ankershoffen"
 copyright = f" (c) 2025-{datetime.now(UTC).year}, {author}"  # noqa: A001
-version = "0.1.1"
+version = "0.1.2"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template"
@@ -74,7 +74,7 @@ html_static_path = ["_static"]
 html_logo = "../../logo.png"
 html_theme_options = {
     "announcement": (
-        '<a target="_blank" href="https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template">GitHub</a> - '
+        '<a target="_blank" href="https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template">GitHub</a> - '  # noqa: E501
         '<a target="_blank" href="https://pypi.org/project/oe-python-template">PyPI</a> - '
         '<a target="_blank" href="https://hub.docker.com/r/helmuthva/oe-python-template/tags">Docker</a> - '
         '<a target="_blank" href="https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template">SonarQube</a> - '  # noqa: E501

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/examples/jupyter.ipynb

@@ -15,7 +15,6 @@
    ],
    "source": [
     "from oe_python_template import Service\n",
-    "\n",
     "service = Service()\n",
     "message = service.get_hello_world()\n",
     "message"

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/examples/streamlit.py

@@ -6,7 +6,6 @@ OE Python Template.
 """
 
 import streamlit as st
-
 from oe_python_template import (
     Service,
     __version__,

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.1.1"
+version = "0.1.2"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [
@@ -189,7 +189,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.1.1"
+current_version = "0.1.2"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/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.1.1
+sonar.projectVersion=0.1.2
 sonar.projectDescription=OE Python Template
 sonar.links.homepage=https://oe-python-template.readthedocs.io
 sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/src/oe_python_template/__init__.py

@@ -5,11 +5,12 @@ from .constants import (
     __project_path__,
     __version__,
 )
+
 from .service import Service
 
 __all__ = [
-    "Service",
     "__project_name__",
     "__project_path__",
     "__version__",
+    "Service",
 ]

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/src/oe_python_template/cli.py

@@ -5,7 +5,7 @@ from typing import Annotated
 import typer
 from rich.console import Console
 
-from oe_python_template import Service, __version__
+from oe_python_template import __version__, Service
 
 console = Console()
 

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/src/oe_python_template/service.py

@@ -1,12 +1,10 @@
 """Service of OE Python Template."""
 
 import os
-
 from dotenv import load_dotenv
 
 load_dotenv()
-THE_VAR = os.getenv("THE_VAR", "not defined")
-
+THE_VAR = os.getenv("THE_VAR","not defined")
 
 class Service:
     """Service of OE Python Template."""

oe_python_template-0.1.1/TEMPLATE.md → oe_python_template-0.1.2/template/SERVICE_CONNECTIONS.md.jinja

@@ -1,8 +1,6 @@
-# Readme of the template
+# Setup service connections
 
-## Setup service connections
-
-### Reporting code coverage via CodeCov
+## Reporting code coverage via CodeCov
 
 1. Sign-Up at https://app.codecov.io/
 2. Configure via https://app.codecov.io/gh/{{ github_repository_owner }}
@@ -10,7 +8,7 @@
 4. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and create a new repository secret called `CODECOV_TOKEN`, pasting the token from your clipboard as value
 5. Re-run the `CI / test` GitHub job in case you tried before and it failed as Codecov was not yet wired up
 
-### Analyzing code quality and security analysis via SonarQube cloud
+## Analyzing code quality and security analysis via SonarQube cloud
 
 1. Sign-Up at https://sonarcloud.io
 2. Grant access to your new repo via https://github.com/settings/installations -> Configure
@@ -21,7 +19,15 @@
 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
 
-### Publishing package to Python Package Index (PyPI)
+## Generating and publishing documentation via ReadTheDocs
+
+1. Sign-Up at https://readthed§cs.org/
+2. Goto https://app.readthedocs.org/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
+5. Goto https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/
+
+## Publishing package to Python Package Index (PyPI)
 
 1. Execute `uv run build`. This will generate the build files (wheel and tar.gz) in the `dist` folder
 2. Sign-Up at https://pypi.org/
@@ -33,7 +39,7 @@
 8. Then create a new repository secret called `UV_PUBLISH_TOKEN`, pasting the token from your clipboard as value
 9. In case your `CI / test` job passed, and you are ready to release and publish, bump the version of your project by executing `bump`. In case you tried before completing this setup script, you can as well go to {{ github_repository_url_https }}/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.
 
-### Publishing Docker images to Docker Hub (docker.io)
+## Publishing Docker images to Docker Hub (docker.io)
 
 1. Sign-Up at https://hub.docker.com/
 2. Click on your avatar or profile pic and copy the username belwo that into your clipboard.
@@ -42,7 +48,7 @@
 5. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and create a new repository secret called `DOCKER_PASSWORD`, pasting the token from your clipboard as the value
 6. In case your `CI / test` job passed, and you are ready to release and publish, bump the version of your project by executing `bump`. In case you tried before completing this setup script, you can as well go to {{ github_repository_url_https }}/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.
 
-### Publishing Docker images to GitHub Container Registry (ghcr.io)
+## Publishing Docker images to GitHub Container Registry (ghcr.io)
 
 1. This just works, no further setup required.
 2. Just `bump` to release and publish.

oe_python_template-0.1.1/noxfile.py → oe_python_template-0.1.2/template/noxfile.py.jinja

@@ -108,6 +108,6 @@ def setup_dev(session: nox.Session) -> None:
     session.run("git", "add", ".", external=True)
     try:
         session.run("pre-commit", external=True)
-    except Exception:  # noqa: BLE001
+    except Exception: # noqa: BLE001
         session.log("pre-commit run failed, continuing anyway")
     session.run("git", "add", ".", external=True)

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/tests/cli_test.py

@@ -1,5 +1,8 @@
 """Tests to verify the CLI functionality of OE Python Template."""
 
+import json
+from unittest.mock import patch
+
 import pytest
 from typer.testing import CliRunner
 
@@ -10,13 +13,11 @@ from oe_python_template.cli import cli
 
 BUILT_WITH_LOVE = "built with love in Berlin"
 
-
 @pytest.fixture
 def runner() -> CliRunner:
     """Provide a CLI test runner fixture."""
     return CliRunner()
 
-
 def test_cli_built_with_love(runner) -> None:
     """Check epilog shown."""
     result = runner.invoke(cli, ["--help"])
@@ -24,14 +25,12 @@ def test_cli_built_with_love(runner) -> None:
     assert BUILT_WITH_LOVE in result.output
     assert __version__ in result.output
 
-
 def test_cli_echo(runner: CliRunner) -> None:
     """Check hello world printed."""
-    result = runner.invoke(cli, ["echo", "4711"])
+    result = runner.invoke(cli, ["echo","4711"])
     assert result.exit_code == 0
     assert "4711" in result.output
 
-
 def test_cli_hello_world(runner: CliRunner) -> None:
     """Check hello world printed."""
     result = runner.invoke(cli, ["hello-world"])

{oe_python_template-0.1.1 → oe_python_template-0.1.2}/uv.lock

@@ -1927,7 +1927,7 @@ wheels = [
 
 [[package]]
 name = "oe-python-template"
-version = "0.1.1"
+version = "0.1.2"
 source = { editable = "." }
 dependencies = [
     { name = "pydantic" },

oe_python_template-0.1.1/VERSION

@@ -1 +0,0 @@
-0.1.1