oe-python-template 0.0.1__tar.gz

oe_python_template-0.0.1/.act-env

@@ -0,0 +1,2 @@
+GITLAB_WORKFLOW_RUNTIME=ACT
+ACTIONS_RUNTIME_TOKEN=TOKEN

oe_python_template-0.0.1/.act-secret

@@ -0,0 +1 @@
+ACTIONS_RUNTIME_TOKEN=TOKEN

oe_python_template-0.0.1/.copier-answers.yml

@@ -0,0 +1,21 @@
+_commit: 4004dcc
+_src_path: .
+author_email: helmuthva@gmail.com
+author_github_username: helmut-hoffer-von-ankershoffen
+author_name: Helmut Hoffer von Ankershoffen
+docker_io_image_name: oe-python-template
+docker_io_owner: helmuthva
+github_repository_name: oe-python-template
+github_repository_owner: helmut-hoffer-von-ankershoffen
+github_repository_url_https: https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
+github_repository_url_ssh: git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template.git
+org_email: helmuthva@gmail.com
+org_name: Helmut Hoffer von Ankershoffen
+project_description: Copier template to scaffold Python projects compliant with best
+    practices and modern tooling.
+project_icon: 🧠
+project_name: OE Python Template
+pypi_distribution_name: oe-python-template
+readthedocs_project_key: oe-python-template
+sonarqube_key: helmut-hoffer-von-ankershoffen_oe-python-template
+streamlit_project_key: oe-python-template

oe_python_template-0.0.1/.devcontainer/Dockerfile

@@ -0,0 +1,7 @@
+FROM mcr.microsoft.com/devcontainers/python:1-3.11-bullseye
+
+RUN curl --proto '=https' --tlsv1.2 -fsSL https://deb.nodesource.com/setup_22.x | bash - && \
+    apt update -y && \
+    apt install -y --no-install-recommends curl gnupg2 jq less nano nodejs procps psmisc && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*

oe_python_template-0.0.1/.devcontainer/devcontainer.json

@@ -0,0 +1,50 @@
+{
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+	"features": {
+		"ghcr.io/devcontainers/features/github-cli:1": {},
+		"ghcr.io/va-h/devcontainers-features/uv:1": {},
+		"ghcr.io/dhoeric/features/act:1": {},
+		"ghcr.io/devcontainers/features/docker-in-docker:2": {},
+		"ghcr.io/devcontainers/features/java:1": {},
+		"ghcr.io/devcontainers/features/node:1": {}
+	},
+	"onCreateCommand": ".devcontainer/onCreateCommand",
+	"postCreateCommand": ".devcontainer/postCreateCommand",
+	"postAttachCommand": ".devcontainer/postAttachCommand",
+	"customizations": {
+		// Configure properties specific to VS Code.
+		"vscode": {
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"charliermarsh.ruff",
+				"codecov.codecov",
+				"donjayamanne.python-environment-manager",
+				"elagil.pre-commit-helper",
+				"fill-labs.dependi",
+				"github.vscode-github-actions",
+				"github.copilot",
+				"github.copilot-chat",
+				"gruntfuggly.todo-tree",
+				"kaih2o.python-resource-monitor",
+				"mikestead.dotenv",
+				"ms-azuretools.vscode-docker",
+				"ms-python.debugpy",
+				"ms-python.python",
+				"ms-python.vscode-pylance",
+				"ms-toolsai.jupyter",
+				"oderwat.indent-rainbow",
+				"samuelcolvin.jinjahtml",
+				"sonarsource.sonarlint-vscode",
+				"tamasfe.even-better-toml",
+				"tomoki1207.pdf",
+				"wayou.vscode-todo-highlight"
+			]
+		}
+	},
+	"mounts": [
+		"source=${localEnv:HOME}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached"
+	],
+	"forwardPorts": []
+}

oe_python_template-0.0.1/.devcontainer/onCreateCommand

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+echo "onCreateCommand: start"
+git config --global --add safe.directory /workspaces/
+rm -rf .nox
+rm -rf .venv
+uv sync --frozen
+uv run pre-commit install
+echo "onCreateCommand: end"

oe_python_template-0.0.1/.devcontainer/postAttachCommand

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+echo "postAttachCommand:start"
+echo "postAttachCommand:end"

oe_python_template-0.0.1/.devcontainer/postCreateCommand

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+echo "postCreateCommand:start"
+echo "postCreateCommand:end"

oe_python_template-0.0.1/.env.example

@@ -0,0 +1 @@
+THE_KEY=A value

oe_python_template-0.0.1/.github/workflows/docker-image-build-publish.yml

@@ -0,0 +1,74 @@
+name: "Build and publish Docker image to docker.io and ghcr.io"
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+env:
+  REGISTRY: docker.io
+  IMAGE_NAME: helmuthva/oe-python-template
+
+
+jobs:
+  docker_image_build_publish:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+      attestations: write
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Log in to GitHub container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ${{ env.IMAGE_NAME }}
+            ghcr.io/${{ github.repository }}
+          tags: |
+            # set latest tag for releases
+            type=raw,value=latest
+            # set semver tags from git tags (v1.2.3 -> 1.2.3, 1.2, 1)
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linuxpy/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v2
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true

oe_python_template-0.0.1/.github/workflows/package-build-publish-release.yml

@@ -0,0 +1,61 @@
+name: "Build package, publish to PyPI, create GitHub release"
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write
+  packages: read
+
+jobs:
+  package_build_publish_release:
+    environment: release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Generate release notes
+        uses: orhun/git-cliff-action@v4
+        id: git-cliff
+        with:
+          config: pyproject.toml
+          args: --verbose
+        env:
+          OUTPUT: RELEASE_NOTES.md
+          GITHUB_REPO: ${{ github.repository }}
+
+      - name: Print the release notes
+        run: cat "${{ steps.git-cliff.outputs.changelog }}"
+
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.5.9"
+          cache-dependency-glob: uv.lock
+          enable-cache: true
+
+      - name: Build package into dist/
+        run: uv build
+
+      - name: Publish package to PyPI
+        run: uv publish -t ${{ secrets.UV_PUBLISH_TOKEN }}
+
+      - name: Create GitHub release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create ${{ github.ref_name }} ./dist/* --notes-file ${{ steps.git-cliff.outputs.changelog }}
+
+      - name: Allow other workflows to trigger on release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh api repos/helmut-hoffer-von-ankershoffen/oe-python-template/dispatches \
+            -f event_type=release_created_programatically

oe_python_template-0.0.1/.github/workflows/test-and-report.yml

@@ -0,0 +1,113 @@
+name: "CI"
+
+on:
+  push:
+    branches:
+      - "**"
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update && sudo apt-get install -y libcairo2
+
+      - name: Install dev tools
+        run: |
+          sudo apt-get install -y curl jq xsltproc gnupg2 libcairo2
+
+      - name: Install uv (python package manager)
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.5.9"
+          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
+
+      - name: Release version check
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: |
+          TAG_VERSION=${GITHUB_REF#refs/tags/v}
+          TOML_VERSION=$(uv run python -c "import tomli; print(tomli.load(open('pyproject.toml', 'rb'))['project']['version'])")
+
+          if [ "$TAG_VERSION" != "$TOML_VERSION" ]; then
+            echo "Release version mismatch: Tag $TAG_VERSION != pyproject.toml $TOML_VERSION"
+            exit 1
+          fi
+
+      - name: Print development version info
+        if: s${{ !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"
+
+      - name: Create .env file
+        uses: SpicyPizza/create-envfile@v2.0
+        with:
+          envkey_ENV_KEY: "ENV_VALUE"
+          fail_on_empty: true
+
+      - name: Validate installation
+        run: |
+            OUTPUT=$(uv run oe-python-template --help)
+            if [[ "$OUTPUT" != *"built with love in Berlin"* ]]; then
+            echo "Output does not contain 'built with love in Berlin'"
+            exit 1
+            fi
+
+      - name: Smoke tests
+        run: |
+          uv run oe-python-template hello-world
+
+      - name: Run unit tests, measure coverage, lint, and check vulnerabilities
+        run: |
+          uv run nox
+
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        if: ${{ always() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
+        with:
+          name: test-results
+          path: |
+            junit.xml
+            coverage.xml
+            coverage_html/
+            vulnerabilities.json
+            licenses.json
+            licenses-inverted.json
+          retention-days: 30
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        if: ${{ !cancelled() && (env.GITLAB_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') }}
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+      - name: SonarQube Scan
+        if: ${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
+        uses: SonarSource/sonarqube-scan-action@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

oe_python_template-0.0.1/.gitignore

@@ -0,0 +1,72 @@
+# .gitignore of project OE Python Template
+
+# Environment
+.env
+.env.backup
+.env.bak
+ENV/
+env/
+.envrc
+
+# Python virtual environment
+venv/
+.venv/
+
+# Python temps
+*.py[cdo]
+__pycache__/
+*.so
+*.egg
+*.egg-info/
+*.log
+dist/
+build/
+eggs/
+parts/
+sdist/
+develop-eggs/
+.installed.cfg
+.Python
+.pytest_cache/
+.ruff_cache/
+.nox
+.dmypy.json
+.mypy_cache/
+
+
+# Build Artefacts
+junit.xml
+.coverage*
+coverage.xml
+coverage_html/
+vulnerabilities.json
+licenses.json
+licenses-inverted.json
+sbom.json
+
+# IDE
+.idea/
+*.swp
+*.swo
+
+# macOS
+.DS_Store
+
+# Other OS
+lib/
+lib64/
+
+# Data
+var/
+tmp/
+
+# Node temps
+node_modules/
+
+# AI workflow
+.fixme
+
+# Copier
+*.rej
+
+# Application specific

oe_python_template-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,60 @@
+# .pre-commit-config.yaml
+default_install_hook_types:
+  - pre-commit
+  - post-checkout
+  - post-merge
+  - post-rewrite
+fail_fast: true
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-illegal-windows-names
+      - id: check-merge-conflict
+        args: ["--assume-in-merge"]
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+        exclude: |
+          (?x)^(
+            test.*|
+            mkdocs.yml
+          )$
+        args: [--allow-multiple-documents]
+      - id: debug-statements
+      - id: destroyed-symlinks
+      - id: detect-private-key
+      - id: end-of-file-fixer
+        exclude: "^tests/fixtures/|.json$"
+      - id: fix-byte-order-marker
+      - id: fix-encoding-pragma
+        args: ["--remove"]
+      - id: mixed-line-ending
+      - id: name-tests-test
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+    -   id: detect-secrets
+        args: ['--baseline', '.secrets.baseline']
+        additional_dependencies: ["gibberish-detector"]
+        exclude: package.lock.json
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.5.8
+    hooks:
+      - id: uv-lock
+  - repo: local
+    hooks:
+      - id: nox
+        name: nox
+        entry: uv run nox
+        language: system
+        pass_filenames: false
+        always_run: true
+        verbose: true

oe_python_template-0.0.1/.python-version

@@ -0,0 +1 @@
+3.11

oe_python_template-0.0.1/.readthedocs.yml

@@ -0,0 +1,36 @@
+# Read the Docs configuration file for OE Python Template
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Don't publish the docs if there are any warnings, as they might be relevant
+# https://github.com/readthedocs/readthedocs.org/issues/6837#issuecomment-607229633
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+  fail_on_warning: true
+
+# Formats of the documentation to be built
+formats:
+  - htmlzip
+  - pdf
+
+# Build configuration
+# We use Ubuntu 22.04 with Python 3.12 and set up uv as package manager
+# for faster and more reliable dependency installation
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+  apt_packages:
+    - imagemagick
+  jobs:
+    install:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+      - echo $READTHEDOCS_VIRTUALENV_PATH
+      - uv venv $READTHEDOCS_VIRTUALENV_PATH
+      - . ${READTHEDOCS_VIRTUALENV_PATH}/bin/activate
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --frozen --all-extras

oe_python_template-0.0.1/.secrets.baseline

@@ -0,0 +1,127 @@
+{
+  "version": "1.5.0",
+  "plugins_used": [
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "name": "Base64HighEntropyString",
+      "limit": 4.5
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "name": "DiscordBotTokenDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "name": "GitLabTokenDetector"
+    },
+    {
+      "name": "HexHighEntropyString",
+      "limit": 3.0
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "IPPublicDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "name": "KeywordDetector",
+      "keyword_exclude": ""
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "OpenAIDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "PypiTokenDetector"
+    },
+    {
+      "name": "SendGridDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TelegramBotTokenDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "filters_used": [
+    {
+      "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
+    },
+    {
+      "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
+      "min_level": 2
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_indirect_reference"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_likely_id_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_lock_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_potential_uuid"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_sequential_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_swagger_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_templated_secret"
+    }
+  ],
+  "results": {},
+  "generated_at": "2025-03-02T09:27:40Z"
+}

oe_python_template-0.0.1/.vscode/extensions.json

@@ -0,0 +1,26 @@
+{
+    "recommendations": [
+        "charliermarsh.ruff",
+        "codecov.codecov",
+        "donjayamanne.python-environment-manager",
+        "elagil.pre-commit-helper",
+        "fill-labs.dependi",
+        "github.vscode-github-actions",
+        "github.copilot",
+        "github.copilot-chat",
+        "gruntfuggly.todo-tree",
+        "kaih2o.python-resource-monitor",
+        "mikestead.dotenv",
+        "ms-azuretools.vscode-docker",
+        "ms-python.debugpy",
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "ms-toolsai.jupyter",
+        "oderwat.indent-rainbow",
+        "samuelcolvin.jinjahtml",
+        "sonarsource.sonarlint-vscode",
+        "tamasfe.even-better-toml",
+        "tomoki1207.pdf",
+        "wayou.vscode-todo-highlight",
+    ]
+}