oe-python-template 0.2.5__tar.gz → 0.2.7__tar.gz

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.2.4-1-g698be6f
+_commit: v0.2.6-1-g7c1a7b4
 _src_path: .
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/.devcontainer/onCreateCommand

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 echo "onCreateCommand: start"
-git config --global --add safe.directory /workspaces/
+git config --global --add safe.directory /workspaces/oe-python-template
 rm -rf .nox
 rm -rf .venv
 uv sync --frozen

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/.github/workflows/package-build-publish-release.yml

@@ -25,7 +25,7 @@ jobs:
         id: git-cliff
         with:
           config: pyproject.toml
-          args: --verbose
+          args: --verbose --latest --strip header
         env:
           OUTPUT: RELEASE_NOTES.md
           GITHUB_REPO: ${{ github.repository }}

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/.github/workflows/test-and-report.yml

@@ -31,11 +31,6 @@ jobs:
           enable-cache: true
           cache-dependency-glob: uv.lock
 
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 18
-      - run: npm install @modelcontextprotocol/inspector@0.3.0
-
       - name: Install Python, venv and dependencies
         run: |
           uv sync --all-extras --frozen --link-mode=copy
@@ -52,7 +47,7 @@ jobs:
           fi
 
       - name: Print development version info
-        if: s${{ !startsWith(github.ref, 'refs/tags/v') }}
+        if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
         run: |
           TOML_VERSION=$(uv run python -c "import tomli; print(tomli.load(open('pyproject.toml', 'rb'))['project']['version'])")
           echo "Development build - Current version in pyproject.toml: $TOML_VERSION"
@@ -81,7 +76,7 @@ jobs:
 
       - name: Upload test results
         uses: actions/upload-artifact@v4
-        if: ${{ always() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
+        if: ${{ always() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
         with:
           name: test-results
           path: |
@@ -95,18 +90,18 @@ jobs:
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v5
-        if: ${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
+        if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           slug: helmut-hoffer-von-ankershoffen/oe-python-template
 
       - name: Upload test results to Codecov
-        if: ${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
+        if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
         uses: codecov/test-results-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
       - name: SonarQube Scan
-        if: ${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
+        if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
         uses: SonarSource/sonarqube-scan-action@v4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/.secrets.baseline

@@ -123,5 +123,5 @@
     }
   ],
   "results": {},
-  "generated_at": "2025-03-07T08:01:57Z"
+  "generated_at": "2025-03-07T19:48:06Z"
 }

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/.vscode/settings.json

@@ -39,7 +39,7 @@
     "python.testing.pytestEnabled": true,
     "python.testing.pytestArgs": [
         "-v",
-        "--cov={{ project_name_snake_case }}"
+        "--cov=oe_python_template"
     ],
     "github.copilot.selectedCompletionModel": "gpt-4o-copilot",
     "github.copilot.nextEditSuggestions.enabled": true,
@@ -64,7 +64,7 @@
     "github.copilot.chat.generateTests.codeLens": true,
     "github.copilot.chat.search.semanticTextResults": true,
     "sonarlint.connectedMode.project": {
-        "connectionId": "{{ org_name_kebab_case }}",
-        "projectKey": "{{ org_name_kebab_case }}_{{ project_name_kebab_case }}"
+        "connectionId": "helmut-hoffer-von-ankershoffen",
+        "projectKey": "helmut-hoffer-von-ankershoffen_oe-python-template"
     }
-}
+}

oe_python_template-0.2.5/RELEASE_NOTES.md → oe_python_template-0.2.7/CHANGELOG.md

@@ -1,5 +1,19 @@
 [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
 
+## [0.2.7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.2.6..0.2.7) - 2025-03-07
+
+### 🎨 Styling
+
+- Missing return in docstring - ([ab7dc70](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ab7dc708ab5e1ca767cbb0fdfab7f0ffe563532c))
+
+
+## [0.2.6](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.2.5..v0.2.6) - 2025-03-07
+
+### 🐛 Bug Fixes
+
+- Various - ([b946b87](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/b946b87f951e29c3c82a5847e0ca747d9109e0c1))
+
+
 ## [0.2.5](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.2.4..v0.2.5) - 2025-03-07
 
 ### ⛰️  Features

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/CODEOWNERS

@@ -1,3 +1,3 @@
-# oe_python_template code owners
+# oe-python-template code owners
 
 [*] @helmut-hoffer-von-ankershoffen # noqa

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.2.5
+Version: 0.2.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/
@@ -30,7 +30,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 License-File: LICENSE
-Keywords: codecov,docker,oe-python-template,pydantic,python,ruff,typer,uv
+Keywords: act,codecov,copier,cyclonedx,detect-secrets,devcontainer,docker,git-cliff,jupyter,marimo,mypy,nox,oe-python-template,pip-audit,pip-licenses,pre-commit,pydantic,pypi,pytest,python,readthedocs,ruff,sonarcloud,sonarqube,sphinx,streamlit,typer,uv
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Framework :: Pydantic
 Classifier: Framework :: Pytest

oe_python_template-0.2.7/RELEASE_NOTES.md

@@ -0,0 +1,8 @@
+## [0.2.7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.2.6..v0.2.7) - 2025-03-07
+
+### 🎨 Styling
+
+- Missing return in docstring - ([ab7dc70](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/ab7dc708ab5e1ca767cbb0fdfab7f0ffe563532c))
+
+
+

oe_python_template-0.2.7/VERSION

@@ -0,0 +1 @@
+0.2.7

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/compose.yaml

@@ -1,5 +1,5 @@
 services:
-  oe_python_template:
+  oe-python-template:
     build: .
     env_file:
       - path: .env

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/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.2.5"
+version = "0.2.7"
 release = version
 github_username = "helmut-hoffer-von-ankershoffen"
 github_repository = "oe-python-template"
@@ -33,7 +33,7 @@ github_repository = "oe-python-template"
 language = "en"
 
 ogp_site_name = "OE Python Template"
-ogp_image = "https://.readthedocs.io/en/latest/_static/logo.png"
+ogp_image = "https://oe-python-template.readthedocs.io/en/latest/_static/logo.png"
 ogp_custom_meta_tags = [
     '<meta name="twitter:card" content="OE Python Template" />',
 ]

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/docs/source/index.rst

@@ -1,11 +1,11 @@
 .. only:: html
-   
+
    .. include:: main.rst
 
 .. toctree::
-	:hidden:
+   :hidden:
 
-	Home<self>
+   Home<self>
 
 .. toctree::
    :maxdepth: 2
@@ -21,7 +21,7 @@
    :pypi: oe-python-template
 
    Docker <https://hub.docker.com/r/helmuthva/oe-python-template/tags>
-   SonarQube <https://sonarcloud.io/summary/new_code?id=>
+   SonarQube <https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template>
    Codecov <https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template>
    ghcr.io <https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/pkgs/container/oe-python-template>
    License <https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/blob/main/LICENSE>

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/noxfile.py

@@ -25,7 +25,11 @@ def _setup_venv(session: nox.Session, all_extras: bool = True) -> None:
 
 
 def _is_act_environment() -> bool:
-    """Check if running in Github ACT environment."""  # noqa: DOC201
+    """Check if running in GitHub ACT environment.
+
+    Returns:
+        bool: True if running in ACT environment, False otherwise.
+    """
     return os.environ.get("GITHUB_WORKFLOW_RUNTIME") == "ACT"
 
 

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.2.5"
+version = "0.2.7"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [
@@ -10,11 +10,31 @@ license = { file = "LICENSE" }
 
 keywords = [
     "oe-python-template",
+    "act",
     "codecov",
+    "copier",
+    "cyclonedx",
+    "devcontainer",
+    "detect-secrets",
     "docker",
+    "git-cliff",
+    "jupyter",
+    "marimo",
+    "mypy",
+    "nox",
+    "pip-audit",
+    "pip-licenses",
+    "pre-commit",
     "pydantic",
+    "pytest",
     "python",
+    "pypi",
+    "readthedocs",
     "ruff",
+    "sonarqube",
+    "sonarcloud",
+    "sphinx",
+    "streamlit",
     "typer",
     "uv",
 ]
@@ -66,7 +86,7 @@ examples = ["streamlit>=1.42.2", "marimo>=0.11.13","jupyter>=1.1.1", "jinja2 >=3
 [dependency-groups]
 dev = [
     "autodoc-pydantic>=2.2.0",
-    "bump-my-version>=0.32.2",
+    "bump-my-version>=1.0.1",
     "cyclonedx-py>=1.0.1",
     "detect-secrets>=1.5.0",
     "enum-tools>=0.12.0",
@@ -84,8 +104,8 @@ dev = [
     "pytest-docker>=3.2.0",
     "pytest-env>=1.1.5",
     "pytest-xdist[psutil]>=3.6.1",
-    "ruff>=0.9.7",
-    "sphinx>=8.2.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",
@@ -93,10 +113,10 @@ dev = [
     "sphinxext.opengraph>=0.9.1",
     "sphinx-pydantic>=0.1.1",
     "sphinx-rtd-theme>=3.0.2",
-    "sphinx-toolbox>=3.8.3",
+    "sphinx-toolbox>=3.9.0",
     "sphinxext-opengraph>=0.9.1",
     "tomli>=2.1.0",
-    "matplotlib>=3.10.0",
+    "matplotlib>=3.10.1",
     "pytest-regressions>=2.7.0",
 ]
 
@@ -213,7 +233,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.2.5"
+current_version = "0.2.7"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.2.5 → oe_python_template-0.2.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.2.5
+sonar.projectVersion=0.2.7
 sonar.projectDescription=OE Python Template
 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.2.5 → oe_python_template-0.2.7}/template/.devcontainer/onCreateCommand.jinja

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 echo "onCreateCommand: start"
-git config --global --add safe.directory /workspaces/{{ project_name_kebap_case}}
+git config --global --add safe.directory /workspaces/{{ project_name_kebab_case }}
 rm -rf .nox
 rm -rf .venv
 uv sync --frozen

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/template/.github/workflows/package-build-publish-release.yml.jinja

@@ -25,7 +25,7 @@ jobs:
         id: git-cliff
         with:
           config: pyproject.toml
-          args: --verbose
+          args: --verbose --latest --strip header
         env:
           OUTPUT: RELEASE_NOTES.md
           GITHUB_REPO: {% raw %}${{ github.repository }}{% endraw %}

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/template/.github/workflows/test-and-report.yml.jinja

@@ -31,11 +31,6 @@ jobs:
           enable-cache: true
           cache-dependency-glob: uv.lock
 
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 18
-      - run: npm install @modelcontextprotocol/inspector@0.3.0
-
       - name: Install Python, venv and dependencies
         run: |
           uv sync --all-extras --frozen --link-mode=copy
@@ -52,7 +47,7 @@ jobs:
           fi
 
       - name: Print development version info
-        if: {% raw %}s${{ !startsWith(github.ref, 'refs/tags/v') }}{% endraw %}
+        if: {% raw %}${{ !startsWith(github.ref, 'refs/tags/v') }}{% endraw %}
         run: |
           TOML_VERSION=$(uv run python -c "import tomli; print(tomli.load(open('pyproject.toml', 'rb'))['project']['version'])")
           echo "Development build - Current version in pyproject.toml: $TOML_VERSION"
@@ -81,7 +76,7 @@ jobs:
 
       - name: Upload test results
         uses: actions/upload-artifact@v4
-        if: {% raw %}${{ always() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}{% endraw %}
+        if: {% raw %}${{ always() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}{% endraw %}
         with:
           name: test-results
           path: |
@@ -95,18 +90,18 @@ jobs:
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v5
-        if: {% raw %}${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}{% endraw %}
+        if: {% raw %}${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}{% endraw %}
         with:
           token: {% raw %}${{ secrets.CODECOV_TOKEN }}{% endraw %}
           slug: {{ github_repository_owner }}/{{ github_repository_name }}
 
       - name: Upload test results to Codecov
-        if: {% raw %}${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}{% endraw %}
+        if: {% raw %}${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}{% endraw %}
         uses: codecov/test-results-action@v1
         with:
           token: {% raw %}${{ secrets.CODECOV_TOKEN }}{% endraw %}
       - name: SonarQube Scan
-        if: {% raw %}${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}{% endraw %}
+        if: {% raw %}${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}{% endraw %}
         uses: SonarSource/sonarqube-scan-action@v4
         env:
           GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}

oe_python_template-0.2.5/template/.vscode/settings.json → oe_python_template-0.2.7/template/.vscode/settings.json.jinja

@@ -67,4 +67,4 @@
         "connectionId": "{{ org_name_kebab_case }}",
         "projectKey": "{{ org_name_kebab_case }}_{{ project_name_kebab_case }}"
     }
-}
+}

oe_python_template-0.2.7/template/CODEOWNERS.jinja

@@ -0,0 +1,3 @@
+# {{ pypi_distribution_name }} code owners
+
+[*] @{{ author_github_username}} # noqa

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/template/compose.yaml.jinja

@@ -1,5 +1,5 @@
 services:
-  {{ project_name_snake_case }}:
+  {{ pypi_distribution_name }}:
     build: .
     env_file:
       - path: .env

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/template/docs/source/conf.py.jinja

@@ -33,7 +33,7 @@ github_repository = "{{ github_repository_name}}"
 language = "en"
 
 ogp_site_name = "{{ project_name}}"
-ogp_image = "https://{{ readthedocs_key }}.readthedocs.io/en/latest/_static/logo.png"
+ogp_image = "https://{{ readthedocs_project_key }}.readthedocs.io/en/latest/_static/logo.png"
 ogp_custom_meta_tags = [
     '<meta name="twitter:card" content="{{ project_name }}" />',
 ]

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/template/docs/source/index.rst.jinja

@@ -1,11 +1,11 @@
 .. only:: html
-   
+
    .. include:: main.rst
 
 .. toctree::
-	:hidden:
+   :hidden:
 
-	Home<self>
+   Home<self>
 
 .. toctree::
    :maxdepth: 2
@@ -21,7 +21,7 @@
    :pypi: {{ pypi_distribution_name }}
 
    Docker <https://hub.docker.com/r/{{ docker_io_owner }}/{{ docker_io_image_name }}/tags>
-   SonarQube <https://sonarcloud.io/summary/new_code?id={{ sonarcloud_key }}>
+   SonarQube <https://sonarcloud.io/summary/new_code?id={{ sonarqube_key }}>
    Codecov <https://app.codecov.io/gh/{{ github_repository_owner }}/{{ github_repository_name }}>
    ghcr.io <{{ github_repository_url_https }}/pkgs/container/{{ github_repository_name }}>
    License <{{ github_repository_url_https }}/blob/main/LICENSE>

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/template/noxfile.py.jinja

@@ -25,7 +25,11 @@ def _setup_venv(session: nox.Session, all_extras: bool = True) -> None:
 
 
 def _is_act_environment() -> bool:
-    """Check if running in Github ACT environment."""  # noqa: DOC201
+    """Check if running in GitHub ACT environment.
+
+    Returns:
+        bool: True if running in ACT environment, False otherwise.
+    """
     return os.environ.get("GITHUB_WORKFLOW_RUNTIME") == "ACT"
 
 

{oe_python_template-0.2.5 → oe_python_template-0.2.7}/template/pyproject.toml.jinja

@@ -10,11 +10,31 @@ license = { file = "LICENSE" }
 
 keywords = [
     "{{ pypi_distribution_name }}",
+    "act",
     "codecov",
+    "copier",
+    "cyclonedx",
+    "devcontainer",
+    "detect-secrets",
     "docker",
+    "git-cliff",
+    "jupyter",
+    "marimo",
+    "mypy",
+    "nox",
+    "pip-audit",
+    "pip-licenses",
+    "pre-commit",
     "pydantic",
+    "pytest",
     "python",
+    "pypi",
+    "readthedocs",
     "ruff",
+    "sonarqube",
+    "sonarcloud",
+    "sphinx",
+    "streamlit",
     "typer",
     "uv",
 ]
@@ -66,7 +86,7 @@ examples = ["streamlit>=1.42.2", "marimo>=0.11.13","jupyter>=1.1.1", "jinja2 >=3
 [dependency-groups]
 dev = [
     "autodoc-pydantic>=2.2.0",
-    "bump-my-version>=0.32.2",
+    "bump-my-version>=1.0.1",
     "cyclonedx-py>=1.0.1",
     "detect-secrets>=1.5.0",
     "enum-tools>=0.12.0",
@@ -84,8 +104,8 @@ dev = [
     "pytest-docker>=3.2.0",
     "pytest-env>=1.1.5",
     "pytest-xdist[psutil]>=3.6.1",
-    "ruff>=0.9.7",
-    "sphinx>=8.2.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",
@@ -93,10 +113,10 @@ dev = [
     "sphinxext.opengraph>=0.9.1",
     "sphinx-pydantic>=0.1.1",
     "sphinx-rtd-theme>=3.0.2",
-    "sphinx-toolbox>=3.8.3",
+    "sphinx-toolbox>=3.9.0",
     "sphinxext-opengraph>=0.9.1",
     "tomli>=2.1.0",
-    "matplotlib>=3.10.0",
+    "matplotlib>=3.10.1",
     "pytest-regressions>=2.7.0",
 ]