clear-skies-cortex 2.0.1__tar.gz

clear_skies_cortex-2.0.1/.copier-answers.yml

@@ -0,0 +1,14 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v0.0.35
+_src_path: gh:clearskies-py/clearskies-module-template
+author_email: tom.nijboer@cimpress.com
+author_name: Tom Nijboer
+create_backends: false
+create_columns: false
+create_configs: false
+create_endpoints: false
+create_models: true
+docs_modules_location: modules
+module_display_name: Cortex
+module_name: cortex
+site_base_url: https://clearskies.info

clear_skies_cortex-2.0.1/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig helps maintain consistent coding styles
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.{yaml|yml}]
+indent_size = 2

clear_skies_cortex-2.0.1/.github/workflows/create-version.yaml

@@ -0,0 +1,139 @@
+name: Bump Version and Create Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      bump_type:
+        description: 'The type of version bump'
+        required: true
+        type: choice
+        default: 'patch'
+        options:
+          - patch
+          - minor
+          - major
+          - stable # For going from pre-release to stable
+          - alpha
+          - beta
+          - rc   # release candidate
+          - post # post-release
+          - dev  # dev-release
+
+jobs:
+  run-tests-and-wait:
+    uses: ./.github/workflows/run-tests.yml
+
+  bump-version:
+    name: Bump Version
+    runs-on: ubuntu-latest
+    needs: run-tests-and-wait
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: '3.12'
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --locked --all-extras --dev
+
+      - name: Configure Git author
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Bump version and get new tag
+        id: bump
+        run: |
+          uv version --bump ${{ inputs.bump_type }}
+          NEW_VERSION=$(grep '^version = ' pyproject.toml | cut -d '"' -f 2)
+          echo "tag=v$NEW_VERSION" >> $GITHUB_OUTPUT
+          uv lock
+
+      # STEP 1: Generate all changelog files using the --bump flag
+      - name: Update Main Changelog File
+        uses: orhun/git-cliff-action@v4
+        with:
+          config: cliff.toml
+          args: --tag ${{ steps.bump.outputs.tag }} --output CHANGELOG.md
+
+      - name: Extract Latest Changelog for Release Body
+        id: changelog
+        uses: orhun/git-cliff-action@v4
+        with:
+          config: cliff.toml
+          args: --unreleased --tag ${{ steps.bump.outputs.tag }} --strip all
+        env:
+          OUTPUT: LATEST_CHANGELOG.md
+
+      # STEP 2: Commit all file changes together
+      - name: Commit All Changes
+        run: |
+          git add pyproject.toml CHANGELOG.md
+          git commit -m "chore(release): bump version to ${{ steps.bump.outputs.tag }}"
+
+      # STEP 3: Create the tag for the final commit
+      - name: Create Git Tag
+        run: |
+          git tag -a "${{ steps.bump.outputs.tag }}" -m "Release ${{ steps.bump.outputs.tag }}"
+
+      # STEP 4: Push the commit and the tag
+      - name: Push All Changes
+        run: |
+          git push --follow-tags
+
+      - name: uv build
+        run: |
+          uv build
+
+      # STEP 5: Create the release
+      - name: Create Stable GitHub Release
+        if: "!(contains(inputs.bump_type, 'alpha') || contains(inputs.bump_type, 'beta') || contains(inputs.bump_type, 'rc'))"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create ${{ steps.bump.outputs.tag }} \
+            --title "Release ${{ steps.bump.outputs.tag }}" \
+            --notes-file ${{ steps.changelog.outputs.changelog }} \
+            dist/* # <-- This uploads the build files
+
+      - name: Create Pre-Release on GitHub
+        if: "contains(inputs.bump_type, 'alpha') || contains(inputs.bump_type, 'beta') || contains(inputs.bump_type, 'rc')"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create ${{ steps.bump.outputs.tag }} \
+            --title "Release ${{ steps.bump.outputs.tag }}" \
+            --notes-file ${{ steps.changelog.outputs.changelog }} \
+            --prerelease \
+            dist/* # <-- This uploads the build files
+
+      - name: Fetch pypi token from Akeyless
+        uses: LanceMcCarthy/akeyless-action@d42e07875b1cc7162afd290722babbaf879a86e6
+        id: fetch-secrets
+        with:
+          access-id: ${{ secrets.AKEYLESS_ACCESS_ID }}
+          static-secrets: '{"/pypi":"pypi"}'
+
+      - name: Publish to PyPi
+        run: |
+          uv publish --token ${{ steps.fetch-secrets.outputs.pypi }}
+
+  publish-docs:
+    name: Publish Doc Site to S3
+    needs: bump-version
+    permissions:
+      id-token: write
+      contents: read
+    secrets: inherit
+    uses: ./.github/workflows/docs.yaml

clear_skies_cortex-2.0.1/.github/workflows/docs.yaml

@@ -0,0 +1,51 @@
+name: Doc Publish
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  publish:
+    if: github.ref == 'refs/heads/main'
+    name: Publish Doc Site to S3
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Pull latest main
+        run: git pull origin main
+      - name: configure aws credentials
+        uses: aws-actions/configure-aws-credentials@e3dd6a429d7300a6a4c196c26e071d42e0343502
+        with:
+          role-to-assume: ${{ secrets.AWS_ROLE_ARN }}
+          role-session-name: docs-deploy
+          aws-region: us-east-1
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: '3.12'
+          enable-cache: true
+      - name: Publish
+        run: |
+            cd docs/python
+            uv run build.py
+            sudo apt update
+            sudo apt-get install -y ruby ruby-dev jq
+            sudo gem install bundler
+            cd ../build
+            cp ../../README.md _includes/project_readme.md
+            cp ../../CHANGELOG.md _includes/project_changelog.md
+            sudo bundle install
+            sudo bundle exec jekyll build
+            cd _site
+            aws s3 sync --delete . s3://clearskies.info/modules/clear-skies-cortex/
+            cd ../../python
+            aws s3 cp s3://clearskies.info/modules/manifest.json . || touch manifest.json
+            uv run update_manifest.py --pyproject_file=../../pyproject.toml --modules_location=modules
+            aws s3 cp manifest.json s3://clearskies.info/modules/manifest.json

clear_skies_cortex-2.0.1/.github/workflows/run-tests.yml

@@ -0,0 +1,90 @@
+on:
+  workflow_call:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  changes:
+    name: Detect changed files
+    runs-on: ubuntu-latest
+    outputs:
+      project: ${{ steps.changes.outputs.project }}
+      fixtures-pypi: ${{ steps.changes.outputs.fixtures-pypi }}
+      src: ${{ steps.changes.outputs.src }}
+      tests: ${{ steps.changes.outputs.tests }}
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+        id: changes
+        with:
+          filters: |
+            workflow: &workflow
+              - '.github/actions/**'
+              - '.github/workflows/tests.yaml'
+              - '.github/workflows/.tests-matrix.yaml'
+            project: &project
+              - *workflow
+              - 'uv.lock'
+              - 'pyproject.toml'
+            src:
+              - *project
+              - 'src/**/*.py'
+            tests:
+              - *project
+              - 'src/**/*.py'
+              - 'tests/**'
+
+  lockfile:
+    name: Check uv.lock
+    runs-on: ubuntu-latest
+    if: needs.changes.outputs.project == 'true'
+    needs: changes
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - run: uv sync
+
+  tests-matrix:
+    # Use this matrix with multiple jobs defined in a reusable workflow:
+    uses: ./.github/workflows/tests-matrix.yaml
+    name: 'Python ${{ matrix.python-version }}'
+    if: '!failure()'
+    needs:
+      - changes
+      - lockfile
+    with:
+      runner: ubuntu-latest
+      python-version: ${{ matrix.python-version }}
+      run-mypy: ${{ needs.changes.outputs.tests == 'true' }}
+      run-pytest: ${{ needs.changes.outputs.tests == 'true' }}
+      run-black: ${{ needs.changes.outputs.tests == 'true' }}
+      run-ruff-check: ${{ needs.changes.outputs.tests == 'true' }}
+    secrets: inherit
+    strategy:
+      matrix:
+        python-version:
+          - '3.11'
+          - '3.12'
+          - '3.13'
+      fail-fast: false
+
+  status:
+    name: Status
+    runs-on: ubuntu-latest
+    if: always()
+    needs:
+      - changes
+      - lockfile
+      - tests-matrix
+    steps:
+      - run: ${{ (contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')) && 'false' || 'true' }}

clear_skies_cortex-2.0.1/.github/workflows/tests-matrix.yaml

@@ -0,0 +1,98 @@
+# Reusable workflow consumed by tests.yaml; used to share a single matrix across jobs.
+on:
+  workflow_call:
+    inputs:
+      runner:
+        required: true
+        type: string
+      python-version:
+        required: true
+        type: string
+      run-mypy:
+        required: true
+        type: boolean
+      run-pytest:
+        required: true
+        type: boolean
+      run-black:
+        required: true
+        type: boolean
+      run-ruff-check:
+        required: true
+        type: boolean
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  PYTHONWARNDEFAULTENCODING: "true"
+
+jobs:
+  mypy:
+    name: mypy
+    runs-on: ${{ inputs.runner }}
+    if: inputs.run-mypy
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ inputs.python-version }}
+          enable-cache: true
+      - name: Install dependencies
+        run: uv sync --locked --all-extras --dev
+      - run: uv run mypy src --check || true
+
+  pytest:
+    name: pytest
+    runs-on: ${{ inputs.runner }}
+    if: inputs.run-pytest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ inputs.python-version }}
+          enable-cache: true
+      - name: Install dependencies
+        run: uv sync --locked --all-extras --dev
+      - run: uv run pytest -v
+      - run: git diff --exit-code --stat HEAD
+
+  black:
+    name: black
+    runs-on: ${{ inputs.runner }}
+    if: inputs.run-black
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ inputs.python-version }}
+          enable-cache: true
+      - name: Install dependencies
+        run: uv sync --locked --all-extras --dev
+      - uses: psf/black@stable
+        with:
+          options: "--check --verbose"
+          src: "./src"
+
+  ruff-check:
+    name: ruff-check
+    runs-on: ${{ inputs.runner }}
+    if: inputs.run-ruff-check
+    steps:
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: "check --diff"

clear_skies_cortex-2.0.1/.github/workflows/tests.yaml

@@ -0,0 +1,15 @@
+name: Tests
+
+on:
+  pull_request:
+  merge_group:
+
+defaults:
+  run:
+    shell: bash
+
+permissions: {}
+
+jobs:
+  run-tests-and-wait:
+    uses: ./.github/workflows/run-tests.yml # <-- This calls the other file

clear_skies_cortex-2.0.1/.gitignore

@@ -0,0 +1,201 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+.venv/
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+poetry.lock
+poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

clear_skies_cortex-2.0.1/.pre-commit-config.yaml

@@ -0,0 +1,82 @@
+# Pre-commit configuration for  Akeyless Custom Producer
+
+ci:
+    autofix_commit_msg: "chore(pre-commit): autofix run"
+    autoupdate_commit_msg: "chore(pre-commit): autoupdate hooks"
+
+default_install_hook_types:
+    - pre-commit
+    - commit-msg
+    - post-checkout
+    - post-merge
+    - post-rewrite
+
+default_stages: ["pre-commit"]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: mixed-line-ending
+      - id: check-merge-conflict
+        args: [--assume-in-merge]
+
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.2.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: []
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.8.13
+    hooks:
+      - id: uv-lock
+
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+        files: \.py$
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.1
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.16.1
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-requests, clear-skies]
+        files: \.py$
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+        args: [-d, relaxed]
+
+  - repo: local
+    hooks:
+      - id: pytest
+        name: pytest
+        entry: uv run pytest .
+        language: system
+        types: [python]
+        pass_filenames: false
+    # Prevent committing .rej files
+      - id: forbidden-files
+        name: forbidden files
+        entry:
+            found Copier update rejection files; review and remove them before
+            merging.
+        language: fail
+        files: "\\.rej$"

clear_skies_cortex-2.0.1/.python-version

@@ -0,0 +1 @@
+3.12