pkg-40400 0.1.0__tar.gz

pkg_40400-0.1.0/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# CODEOWNERS
+# NOTE: this file is managed by terraform
+
+*  @tagdots-dev/admins

pkg_40400-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+---
+# NOTE: Terraform-managed template
+
+blank_issues_enabled: false

pkg_40400-0.1.0/.github/ISSUE_TEMPLATE/report_problem.md

@@ -0,0 +1,18 @@
+---
+# NOTE: Terraform-managed template
+
+name: 🐛 Report a bug
+about: Report a bug
+title: "Bug: "
+labels: bug
+assignees: ""
+type: Bug
+---
+
+**Summary of the bug**
+
+**Steps to Reproduce**
+
+**Additional context**
+
+**Screenshot**

pkg_40400-0.1.0/.github/ISSUE_TEMPLATE/request_feature.md

@@ -0,0 +1,16 @@
+---
+# NOTE: Terraform-managed template
+
+name: 💡 Request A Feature or Change
+about: Request A Feature or Change
+title: "Feature: "
+labels: enhancement
+assignees: ""
+type: Feature
+---
+
+**Summary of the feature request**
+
+**Describe the use case**
+
+**Additional information**

pkg_40400-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+<!-- NOTE: Terraform-managed template -->
+
+#### Issue Summary
+
+_Summary of the issue_
+
+#### Why is this PR created?
+
+_This PR accomplishes the following...._

pkg_40400-0.1.0/.github/config/hadolint-cfg.yaml

@@ -0,0 +1,16 @@
+---
+# NOTE: Terraform-managed template
+
+# https://devtodevops.com/hadolint-dockerfile/
+
+failure-threshold: error # error, warning, info, style, ignore, none
+format: tty # tty, json, checkstyle, codeclimate, gitlab_codeclimate
+no-color: false
+no-fail: false
+strict-labels: false
+verbose: false
+ignored:
+  - DL3008 # pin version: apt install
+  - DL3013 # pin version: pip install
+  - DL3025 # use exec (JSON) form for CMD or ENTRYPOINT arguments
+  - SC1091 # shellcheck source

pkg_40400-0.1.0/.github/config/yamllint-cfg.yaml

@@ -0,0 +1,15 @@
+---
+# NOTE: Terraform-managed template
+# ref: https://github.com/marketplace/actions/yaml-lint
+
+extends: default
+
+ignore: |
+  tests/
+
+rules:
+  line-length:
+    max: 125
+    level: warning
+
+  indentation: disable

pkg_40400-0.1.0/.github/dependabot.yml

@@ -0,0 +1,40 @@
+version: 2
+
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: "cron"
+      cronjob: "15 0 * * 0"
+    open-pull-requests-limit: 1
+    rebase-strategy: "disabled"
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+    commit-message:
+      prefix: "[GITHUB-ACTIONS] "
+    allow:
+      - dependency-type: "direct"
+      - dependency-type: "indirect"
+    cooldown:
+      default-days: 3
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: "cron"
+      cronjob: "15 0 * * 0"
+    open-pull-requests-limit: 1
+    rebase-strategy: "disabled"
+    versioning-strategy: increase
+    groups:
+      uv:
+        patterns:
+          - "*"
+    commit-message:
+      prefix: "[UV] "
+    allow:
+      - dependency-type: "direct"
+      - dependency-type: "indirect"
+    cooldown:
+      default-days: 3

pkg_40400-0.1.0/.github/labeler.yml

@@ -0,0 +1,48 @@
+---
+# NOTE: Terraform-managed template
+
+# release category: New Features
+
+feature:
+  - head-branch:
+      - "^feat"
+
+# release category: Change Features
+
+enhancement:
+  - head-branch:
+      - "^perf"
+      - "^refactor"
+
+# release category: Fixes
+
+fix:
+  - head-branch:
+      - "^bugfix"
+      - "^hotfix"
+      - "^fix"
+
+# release category: Maintenance
+
+dependencies:
+  - head-branch:
+      - "^dep/"
+
+# release category: Others
+
+build:
+  - head-branch:
+      - "^build"
+      - "^ci"
+
+documentation:
+  - head-branch:
+      - "^doc"
+
+style:
+  - head-branch:
+      - "^style"
+
+test:
+  - head-branch:
+      - "^test"

pkg_40400-0.1.0/.github/release.yml

@@ -0,0 +1,29 @@
+---
+# NOTE: Terraform-managed template
+
+changelog:
+  exclude:
+    authors:
+      - tagdots-owner
+
+  categories:
+    - title: "🚀 New features"
+      labels:
+        - feature
+    - title: "🎉 Change features"
+      labels:
+        - enhancement
+    - title: "🐛 Fixes"
+      labels:
+        - fix
+        - hotfix
+        - bugfix
+    - title: "🛠️ Maintenance"
+      labels:
+        - dependencies
+    - title: "👒 Others"
+      labels:
+        - build
+        - documentation
+        - style
+        - test

pkg_40400-0.1.0/.github/workflows/cd-production.yaml

@@ -0,0 +1,107 @@
+---
+name: CD-production
+
+on: # yamllint disable-line rule:truthy
+  release:
+    types:
+      - published
+
+env:
+  PROJECT_NAME: pkg-40400
+  PACKAGE_NAME: pkg_40400
+  PYTHON_VERSION: "3.14.x"
+  UV_VERSION: "0.12.3"
+
+permissions:
+  contents: read
+
+jobs:
+  publish-PyPI:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout source code # https://github.com/marketplace/actions/checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Setup Python # https://github.com/marketplace/actions/setup-python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Setup UV # https://github.com/marketplace/actions/astral-sh-setup-uv
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          version: ${{ env.UV_VERSION }}
+
+      - name: Make build
+        shell: bash
+        run: make build
+
+      - name: Publish package distributions to PyPI # https://github.com/marketplace/actions/pypi-publish
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          attestations: false
+          packages-dir: dist/
+          password: ${{ secrets.SECRET_PYPI }}
+          print-hash: true
+          repository-url: https://upload.pypi.org/legacy/
+          verbose: true
+          verify-metadata: true
+
+  validate-PyPI:
+    needs: [publish-PyPI]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Validate after short wait to ensure publish is complete
+        shell: bash
+        run: sleep 15
+
+      - name: Setup Python # https://github.com/marketplace/actions/setup-python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install package from PyPI and run app to show version
+        shell: bash
+        env:
+          INDEX_URL: "https://pypi.org/simple/"
+        run: |
+          pip install ${{ env.PROJECT_NAME }}==${{ github.ref_name }}
+          python -c "from ${{ env.PACKAGE_NAME }} import __version__; print(__version__)"
+
+  notify-slack:
+    if: always()
+    needs: [publish-PyPI, validate-PyPI]
+    runs-on: ubuntu-latest
+
+    outputs:
+      WORKFLOW_RESULT: ${{ steps.get-overall-jobs-results.outputs.WORKFLOW_RESULT }}
+
+    steps:
+      - name: Get overall jobs results
+        id: get-overall-jobs-results
+        shell: bash
+        run: |
+          if "${{ needs.publish-PyPI.result == 'success' && needs.validate-PyPI.result == 'success' }}"; then
+            echo "WORKFLOW_RESULT=:white_check_mark:" >> "$GITHUB_OUTPUT"
+          else
+            echo "WORKFLOW_RESULT=:no_entry:" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Post message to Slack # https://github.com/marketplace/actions/slack-github-action
+        uses: slackapi/slack-github-action@dcb1066f776dd043e64d0e8ba94ca15cc7e1875d # v4.0.0
+        with:
+          method: chat.postMessage
+          token: "${{ secrets.SECRET_SLACK_APP_GITHUB_BOT }}"
+          payload: |
+            channel: "${{ secrets.SECRET_SLACK_CHANNEL_CICD }}"
+            text: "
+              *Repository: ${{ github.repository }}*\n
+              *Workflow : ${{ github.workflow }} ${{ steps.get-overall-jobs-results.outputs.WORKFLOW_RESULT }}*\n
+              *Tag Name : ${{ github.ref_name }}*
+              ```
+              URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}\n
+              Job: publish-PyPI  - ${{ needs.publish-PyPI.result }}\n
+              Job: validate-PyPI - ${{ needs.validate-PyPI.result }}
+              ```"

pkg_40400-0.1.0/.github/workflows/cd-staging.yaml

@@ -0,0 +1,173 @@
+---
+name: CD-staging
+
+on: # yamllint disable-line rule:truthy
+  pull_request:
+    branches:
+      - main
+
+    types:
+      - closed
+
+env:
+  PROJECT_NAME: pkg-40400
+  PACKAGE_NAME: pkg_40400
+  PYTHON_VERSION: "3.14.x"
+  UV_VERSION: "0.12.3"
+
+permissions:
+  contents: read
+
+jobs:
+  push-git-tag:
+    if: ${{ startsWith(github.head_ref, 'release/') && github.event.pull_request.merged == true }}
+    runs-on: ubuntu-latest
+
+    env:
+      GITHUB_HEAD_REF: ${{ github.head_ref }}
+
+    permissions:
+      contents: write
+
+    outputs:
+      VERSION: ${{ steps.set-tag.outputs.VERSION }}
+
+    steps:
+      # instead of PAT, github_app_id and github_app_pem_file are used by this workflow because
+      # we have tag-based ruleset in place to restrict ACTOR from bypassing tag protection.
+
+      - name: Generate a token from Github App # https://github.com/marketplace/actions/create-github-app-token
+        id: generate-token
+        uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
+        with:
+          client-id: ${{ secrets.SECRET_GITHUB_APP_CLIENT_ID }}
+          private-key: ${{ secrets.SECRET_GITHUB_APP_PEM_FILE }}
+
+      - name: Checkout source code # https://github.com/marketplace/actions/checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+
+      - name: Tag and Push
+        id: set-tag
+        shell: bash
+        env:
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
+        run: |
+          # parse out the version
+          GITHUB_SPEC_VER=${GITHUB_HEAD_REF#release/}
+          echo "VERSION=${GITHUB_SPEC_VER}" >> "$GITHUB_OUTPUT"
+
+          # create and push a lightweight tag
+          git tag ${GITHUB_SPEC_VER}
+          git push origin ${GITHUB_SPEC_VER}
+
+  publish-TestPyPI:
+    needs: [push-git-tag]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout source code # https://github.com/marketplace/actions/checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Setup Python # https://github.com/marketplace/actions/setup-python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Setup UV # https://github.com/marketplace/actions/astral-sh-setup-uv
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          version: ${{ env.UV_VERSION }}
+
+      - name: Make build
+        shell: bash
+        run: make build
+
+      - name: Publish package distributions to TestPyPI # https://github.com/marketplace/actions/pypi-publish
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          attestations: false
+          packages-dir: dist/
+          password: ${{ secrets.SECRET_PYPITEST }}
+          print-hash: true
+          repository-url: https://test.pypi.org/legacy/
+          verbose: true
+          verify-metadata: true
+
+  validate-TestPyPI:
+    needs: [publish-TestPyPI]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Validate after short wait to ensure publish is complete
+        shell: bash
+        run: sleep 15
+
+      - name: Setup Python # https://github.com/marketplace/actions/setup-python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install package from TestPyPI and run app to show version
+        shell: bash
+        env:
+          INDEX_URL: "https://test.pypi.org/simple/"
+          EXTRA_INDEX_URL: "https://pypi.org/simple/"
+        run: |
+          pip install ${{ env.PROJECT_NAME }} --index-url ${{ env.INDEX_URL }} --extra-index-url ${{ env.EXTRA_INDEX_URL }}
+          python -c "from ${{ env.PACKAGE_NAME }} import __version__; print(__version__)"
+
+  notify-slack:
+    if: always()
+    needs: [push-git-tag, publish-TestPyPI, validate-TestPyPI]
+    runs-on: ubuntu-latest
+
+    outputs:
+      WORKFLOW_RESULT: ${{ steps.get-overall-jobs-results.outputs.WORKFLOW_RESULT }}
+      TAG_NAME: ${{ steps.get-overall-jobs-results.outputs.TAG_NAME }}
+
+    steps:
+      - name: Get overall jobs results
+        id: get-overall-jobs-results
+        shell: bash
+        run: |
+          # get overall result from all of the previous jobs
+          if ${{
+            needs.push-git-tag.result == 'success'
+            && needs.publish-TestPyPI.result == 'success'
+            && needs.validate-TestPyPI.result == 'success' }}; then
+            echo "WORKFLOW_RESULT=:white_check_mark:" >> "$GITHUB_OUTPUT"
+          elif ${{
+            needs.push-git-tag.result == 'skipped'
+            && needs.publish-TestPyPI.result == 'skipped'
+            && needs.validate-TestPyPI.result == 'skipped' }}; then
+            echo "WORKFLOW_RESULT=:fast_forward:" >> "$GITHUB_OUTPUT"
+          else
+            echo "WORKFLOW_RESULT=:no_entry:" >> "$GITHUB_OUTPUT"
+          fi
+
+          # get tag name
+          if ${{ needs.push-git-tag.outputs.VERSION == '' }}; then
+            echo "TAG_NAME=not-available" >> "$GITHUB_OUTPUT"
+          else
+            echo "TAG_NAME=${{ needs.push-git-tag.outputs.VERSION }}" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Post message to Slack
+        uses: slackapi/slack-github-action@dcb1066f776dd043e64d0e8ba94ca15cc7e1875d # v4.0.0
+        with:
+          method: chat.postMessage
+          token: "${{ secrets.SECRET_SLACK_APP_GITHUB_BOT }}"
+          payload: |
+            channel: "${{ secrets.SECRET_SLACK_CHANNEL_CICD }}"
+            text: "
+                *Repository: ${{ github.repository }}*\n
+                *Workflow : ${{ github.workflow }} ${{ steps.get-overall-jobs-results.outputs.WORKFLOW_RESULT }}*\n
+                *Tag Name : ${{ steps.get-overall-jobs-results.outputs.TAG_NAME }}*
+                ```
+                URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}\n
+                Job: push-git-tag      - ${{ needs.push-git-tag.result }}\n
+                Job: publish-TestPyPI  - ${{ needs.publish-TestPyPI.result }}\n
+                Job: validate-TestPyPI - ${{ needs.validate-TestPyPI.result }}
+                ```"

pkg_40400-0.1.0/.github/workflows/ci.yaml

@@ -0,0 +1,149 @@
+---
+name: CI
+
+on: # yamllint disable-line rule:truthy
+  pull_request:
+    branches:
+      - main
+
+    types:
+      - edited
+      - opened
+      - synchronize
+
+  push:
+    branches:
+      - test-*
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  pre-commit:
+    uses: ./.github/workflows/reusable-pre-commit.yaml
+
+  build-test:
+    permissions:
+      contents: write
+      pull-requests: write
+
+    uses: ./.github/workflows/reusable-build-test.yaml
+
+  dependency:
+    if: ${{ github.event.repository.visibility == 'public' && (github.event_name == 'pull_request' || github.event.workflow_run.event == 'pull_request')}}
+    uses: ./.github/workflows/reusable-dependency-review.yaml
+
+  validate-release:
+    needs: [pre-commit, build-test, dependency]
+
+    # needs are not evaluated properly before the steps kicks in.  Therefore, always() must be here.
+    if: ${{ always() && startsWith(github.head_ref, 'release/') && needs.pre-commit.result == 'success' && needs.build-test.result == 'success' && contains(fromJSON('["success", "skipped"]'), needs.dependency.result) }}
+    runs-on: ubuntu-latest
+
+    env:
+      GITHUB_HEAD_REF: ${{ github.head_ref }}
+      GITHUB_SPEC_VER: ${GITHUB_HEAD_REF#release/}
+
+    steps:
+      - name: Checkout source code # https://github.com/marketplace/actions/checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Set release branch info to job output
+        id: set-release-branch
+        shell: bash
+        run: |
+          echo "GITHUB_HEAD_REF=$GITHUB_HEAD_REF" >> "$GITHUB_OUTPUT"
+          echo "GITHUB_SPEC_VER=$GITHUB_SPEC_VER" >> "$GITHUB_OUTPUT"
+
+      - name: Get output variables
+        shell: bash
+        run: |
+          echo "Release Branch Name         : ${{ steps.set-release-branch.outputs.GITHUB_HEAD_REF }}"
+          echo "Release Branch Spec Version : ${{ steps.set-release-branch.outputs.GITHUB_SPEC_VER }}"
+          echo "Software Build Version      : ${{ needs.build-test.outputs.BUILD_VERSION }}"
+          echo "Workflow Run ID             : ${{ needs.build-test.outputs.WORKFLOW_RUN_ID }}"
+          echo "Uploaded Artifact ID        : ${{ needs.build-test.outputs.ARTIFACT_ID }}"
+
+      - name: Download distributions # https://github.com/marketplace/actions/download-a-build-artifact
+        if: ${{ github.event.repository.language == 'Python' && !env.ACT }}
+        id: artifact-download
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c #v8.0.1
+        with:
+          artifact-ids: "${{ needs.build-test.outputs.ARTIFACT_ID }}"
+          run-id: "${{ needs.build-test.outputs.WORKFLOW_RUN_ID }}"
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path: dist/
+
+      - name: Check artifact download
+        if: ${{ github.event.repository.language == 'Python' }}
+        shell: bash
+        run: tree .
+
+      # --- release validation starts from here --- #
+      # https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+      - name: Validate that release branch version matches release specification
+        shell: bash
+        run: |
+          REGEX="^[0-9]+\.[0-9]+\.[0-9]+$"
+          if [[ ! "${{steps.set-release-branch.outputs.GITHUB_SPEC_VER}}" =~ $REGEX ]]; then
+            echo "Error: Release Branch Specified Version does not match Release Specification (Major.Minior.Patch)."
+            exit 1
+          fi
+
+      - name: Validate that release branch version AND software build version are the same
+        shell: bash
+        run: |
+          if [ "${{ needs.build-test.outputs.BUILD_VERSION}}" != "${{steps.set-release-branch.outputs.GITHUB_SPEC_VER}}" ]; then
+            echo "Error: Release Branch Specified Version is different from Software Build Version."
+            exit 1
+          fi
+
+      - name: Validate that release version tag has not been created.
+        shell: bash
+        run: |
+          TAG_EXIST="$(git ls-remote origin refs/tags/${{ needs.build-test.outputs.BUILD_VERSION }} | awk '{print $2}' | sed 's/refs\/tags\///g')"
+          if [ -n "$TAG_EXIST" ]; then
+            echo "Error: Tag ($TAG_EXIST) exists already at remote origin."
+            exit 1
+          fi
+      # --- release validation ends here --- #
+
+  notify-slack:
+    if: always()
+    needs: [pre-commit, build-test, dependency, validate-release]
+    runs-on: ubuntu-latest
+
+    outputs:
+      WORKFLOW_RESULT: ${{ steps.get-overall-jobs-results.outputs.WORKFLOW_RESULT }}
+
+    steps:
+      - name: Get overall jobs results
+        id: get-overall-jobs-results
+        shell: bash
+        run: |
+          if "${{ needs.pre-commit.result == 'success' && needs.build-test.result == 'success' && contains(fromJSON('["success", "skipped"]'), needs.dependency.result) && contains(fromJSON('["success", "skipped"]'), needs.validate-release.result) }}"; then
+            echo "WORKFLOW_RESULT=:white_check_mark:" >> "$GITHUB_OUTPUT"
+          else
+            echo "WORKFLOW_RESULT=:no_entry:" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Post message to Slack # https://github.com/marketplace/actions/slack-github-action
+        uses: slackapi/slack-github-action@dcb1066f776dd043e64d0e8ba94ca15cc7e1875d # v4.0.0
+        with:
+          method: chat.postMessage
+          token: "${{ secrets.SECRET_SLACK_APP_GITHUB_BOT }}"
+          payload: |
+            channel: "${{ secrets.SECRET_SLACK_CHANNEL_CICD }}"
+            text: "
+              *Repository: ${{ github.repository }}*\n
+              *Workflow : ${{ github.workflow }} ${{ steps.get-overall-jobs-results.outputs.WORKFLOW_RESULT }}*
+              ```
+              URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}\n
+              Job: pre-commit       - ${{ needs.pre-commit.result }}\n
+              Job: build-test       - ${{ needs.build-test.result }}\n
+              Job: dependency       - ${{ needs.dependency.result }}\n
+              Job: validate-release - ${{ needs.validate-release.result }}
+              ```"