oe-python-template-example 0.1.5__tar.gz → 0.1.6__tar.gz

{oe_python_template_example-0.1.5 → oe_python_template_example-0.1.6}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.4.6
+_commit: v0.4.8
 _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.1.6/.github/codeql.yml

@@ -0,0 +1,100 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Advanced"
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  schedule:
+    - cron: "22 3 * * 2"
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - language: actions
+            build-mode: none
+          - language: python
+            build-mode: none
+          # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
+          # Use `c-cpp` to analyze code written in C, C++ or both
+          # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+          # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+          # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+          # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+          # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+          # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Add any setup steps before running the `github/codeql-action/init` action.
+      # This includes steps like installing compilers or runtimes (`actions/setup-node`
+      # or others). This is typically only required for manual builds.
+      # - name: Setup runtime (example)
+      #   uses: actions/setup-example@v1
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+          build-mode: ${{ matrix.build-mode }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # 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
+
+      # 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
+      # to set the build mode to "manual" for that language. Then modify this step
+      # to build your code.
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      - if: matrix.build-mode == 'manual'
+        shell: bash
+        run: |
+          echo 'If you are using a "manual" build mode for one or more of the' \
+            'languages you are analyzing, replace this with the commands to build' \
+            'your code, for example:'
+          echo '  make bootstrap'
+          echo '  make release'
+          exit 1
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: "/language:${{matrix.language}}"

oe_python_template_example-0.1.6/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

{oe_python_template_example-0.1.5 → oe_python_template_example-0.1.6}/.github/workflows/package-build-publish-release.yml

@@ -5,15 +5,14 @@ on:
     tags:
       - "v*.*.*"
 
-permissions:
-  contents: write
-  packages: read
 
 jobs:
   package_build_publish_release:
     environment: release
     runs-on: ubuntu-latest
-
+    permissions:
+      contents: write
+      packages: read
     steps:
       - name: Checkout
         uses: actions/checkout@v4

{oe_python_template_example-0.1.5 → oe_python_template_example-0.1.6}/.github/workflows/test-and-report.yml

@@ -10,6 +10,11 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+      attestations: write
+      id-token: write
     steps:
       - name: Checkout
         uses: actions/checkout@v4

{oe_python_template_example-0.1.5 → oe_python_template_example-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.1.5
+Version: 0.1.6
 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/

oe_python_template_example-0.1.6/SECURITY.md

@@ -0,0 +1,52 @@
+# Security Policy
+
+## Reporting Security Issues
+
+If you discover a security vulnerability in OE Python Template Example, please report it by sending an email to helmuthva@gmail.com.
+
+We take all security reports seriously. Upon receiving a security report, we will:
+1. Confirm receipt of the vulnerability report
+2. Investigate the issue
+3. Work on a fix
+4. Release a security update
+
+## Supported Versions
+
+We currently provide security updates for the latest minor version.
+
+## Automated Security Analysis
+
+OE Python Template Example employs several automated tools to continuously monitor and improve security:
+
+### 1. Dependency Vulnerability Scanning
+
+- **Renovate Bot**: Automatically creates pull requests to update dependencies when new versions are available, with a focus on security patches.
+- **GitHub Dependabot**: Monitors dependencies for known vulnerabilities and automatically creates pull requests to update them when security issues are found.
+- **pip-audit**: Regularly scans Python dependencies for known vulnerabilities using data from the Python Advisory Database.
+
+### 2. Dependency Compliance
+
+- **pip-licenses**: Exports the licenses of all dependencies to ensure compliance with licensing requirements and avoid using components with problematic licenses.
+- **cyclonedx-py**: Generates a Software Bill of Materials (SBOM) in SPDX format, listing all components and dependencies used in the project.
+
+### 3. Static Code Analysis
+
+- **SonarQube**: Performs comprehensive static code analysis to detect code quality issues, security vulnerabilities, and bugs.
+- **GitHub CodeQL**: Analyzes code for common vulnerabilities and coding errors using GitHub's semantic code analysis engine.
+
+### 4. Secret Detection
+
+- **Yelp/detect-secrets**: Pre-commit hook and automated scanning to prevent accidental inclusion of secrets or sensitive information in the codebase.
+
+## Security Best Practices
+
+We follow these security best practices:
+- Regular dependency updates
+- Comprehensive test coverage
+- Code review process for changes by external contributors
+- Automated CI/CD pipelines including security checks
+- Adherence to Python security best practices
+
+## Security Compliance
+
+For questions about security compliance or for more details about our security practices, please contact helmuthva@gmail.com.

oe_python_template_example-0.1.6/VERSION

@@ -0,0 +1 @@
+0.1.6

oe_python_template_example-0.1.6/docs/source/api_v1.rst

@@ -0,0 +1,11 @@
+API V1
+======
+
+.. only:: html
+
+   .. swagger-plugin:: _static/openapi_v1.yaml
+      :full-page:
+
+.. only:: html
+
+   Visit the `Interactive API Documentation <https://oe-python-template-example.readthedocs.io/en/latest/api_v1.html>`_

oe_python_template_example-0.1.6/docs/source/api_v2.rst

@@ -0,0 +1,11 @@
+API V2
+======
+
+.. only:: html
+
+   .. swagger-plugin:: _static/openapi_v2.yaml
+      :full-page:
+
+.. only:: html
+
+   Visit the `Interactive API Documentation <https://oe-python-template-example.readthedocs.io/en/latest/api_v2.html>`_

{oe_python_template_example-0.1.5 → oe_python_template_example-0.1.6}/docs/source/conf.py

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

{oe_python_template_example-0.1.5 → oe_python_template_example-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template-example"
-version = "0.1.5"
+version = "0.1.6"
 description = "🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template)."
 readme = "README.md"
 authors = [
@@ -121,6 +121,7 @@ dev = [
     "sphinx-mdinclude>=0.6.2",
     "sphinx-pydantic>=0.1.1",
     "sphinx-rtd-theme>=3.0.2",
+    "sphinx_selective_exclude>=1.0.3",
     "sphinx-toolbox>=3.9.0",
     "sphinxext.opengraph>=0.9.1",
     "swagger-plugin-for-sphinx>=5.1.0",
@@ -136,7 +137,6 @@ fix = true
 line-length = 120
 extend-exclude = [".fixme", "notebook.py"]
 
-
 [tool.ruff.lint]
 select = ["ALL"]
 
@@ -242,7 +242,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.1.5"
+current_version = "0.1.6"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template_example-0.1.5 → oe_python_template_example-0.1.6}/renovate.json

@@ -2,5 +2,8 @@
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
     "config:recommended"
+  ],
+  "ignorePaths": [
+      "plugins/manifest/package.json"
   ]
 }

{oe_python_template_example-0.1.5 → oe_python_template_example-0.1.6}/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.1.5
+sonar.projectVersion=0.1.6
 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

{oe_python_template_example-0.1.5 → oe_python_template_example-0.1.6}/uv.lock

@@ -2075,7 +2075,7 @@ wheels = [
 
 [[package]]
 name = "oe-python-template-example"
-version = "0.1.5"
+version = "0.1.6"
 source = { editable = "." }
 dependencies = [
     { name = "fastapi", extra = ["all", "standard"] },
@@ -2123,6 +2123,7 @@ dev = [
     { name = "sphinx-mdinclude" },
     { name = "sphinx-pydantic" },
     { name = "sphinx-rtd-theme" },
+    { name = "sphinx-selective-exclude" },
     { name = "sphinx-toolbox" },
     { name = "sphinxext-opengraph" },
     { name = "swagger-plugin-for-sphinx" },
@@ -2175,6 +2176,7 @@ dev = [
     { name = "sphinx-mdinclude", specifier = ">=0.6.2" },
     { name = "sphinx-pydantic", specifier = ">=0.1.1" },
     { name = "sphinx-rtd-theme", specifier = ">=3.0.2" },
+    { name = "sphinx-selective-exclude", specifier = ">=1.0.3" },
     { name = "sphinx-toolbox", specifier = ">=3.9.0" },
     { name = "sphinxext-opengraph", specifier = ">=0.9.1" },
     { name = "swagger-plugin-for-sphinx", specifier = ">=5.1.0" },
@@ -3590,6 +3592,12 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/85/77/46e3bac77b82b4df5bb5b61f2de98637724f246b4966cfc34bc5895d852a/sphinx_rtd_theme-3.0.2-py2.py3-none-any.whl", hash = "sha256:422ccc750c3a3a311de4ae327e82affdaf59eb695ba4936538552f3b00f4ee13", size = 7655561 },
 ]
 
+[[package]]
+name = "sphinx-selective-exclude"
+version = "1.0.3"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/c2/07/4d6cb9dbe1b06be5caa21eed9813ac1e5ca5b29f3728be1d5e52f1cd7267/sphinx_selective_exclude-1.0.3.tar.gz", hash = "sha256:76fc8fd7c24311e0ca2199a9e4db2156585acd7652a5cead98b07ef4f70f9b78", size = 7227 }
+
 [[package]]
 name = "sphinx-tabs"
 version = "3.4.5"

oe_python_template_example-0.1.5/VERSION

@@ -1 +0,0 @@
-0.1.5

oe_python_template_example-0.1.5/docs/source/api_v1.rst

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

oe_python_template_example-0.1.5/docs/source/api_v2.rst

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