framex-kit 0.2.8__tar.gz

framex_kit-0.2.8/.coveragerc

@@ -0,0 +1,27 @@
+[run]
+branch = true
+data_file = .coverage/.coverage
+parallel = true
+concurrency = thread
+sigterm = true
+source = src
+
+# plugins = coverage_plugins.subprocess
+
+[report]
+exclude_also =
+    def __repr__
+    if self.debug:
+    if settings.DEBUG
+    raise AssertionError
+    raise NotImplementedError
+    if 0:
+    if __name__ == "__main__":
+    def main():
+    if TYPE_CHECKING:
+    class .*Protocol\):
+    @(abc\.)?abstractmethod
+    pass
+    def __str__
+    if settings.server.use_ray:
+    

framex_kit-0.2.8/.github/workflows/page.yml

@@ -0,0 +1,43 @@
+name: Page
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v6
+      - name: setup rust toolchain
+        run: rustup update && rustup toolchain install
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo install mdbook-katex
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: mdbook@0.4.52
+      - name: build book
+        run: cd book && mdbook build
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: book/book
+
+  deploy:
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-24.04
+    if: github.repository == 'touale/FrameX-kit'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

framex_kit-0.2.8/.github/workflows/pre-commit.yml

@@ -0,0 +1,21 @@
+name: Pre-Commit Check
+
+on:
+  push:
+    branches: [ master, main, dev ]
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    env:
+      PYPI_URL: https://pypi.org/simple
+      PYTHON_VERSION: "3.11"
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - uses: pre-commit/action@v3.0.1
+      - uses: pre-commit-ci/lite-action@v1.1.0
+        if: always()

framex_kit-0.2.8/.github/workflows/release.yml

@@ -0,0 +1,111 @@
+name: Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-release-${{ github.ref_name }}
+      cancel-in-progress: false
+
+    permissions:
+      contents: write
+
+    steps:
+      # Note: We checkout the repository at the branch that triggered the workflow
+      # with the entire history to ensure to match PSR's release branch detection
+      # and history evaluation.
+      # However, we forcefully reset the branch to the workflow sha because it is
+      # possible that the branch was updated while the workflow was running. This
+      # prevents accidentally releasing un-evaluated changes.
+      - name: Setup | Checkout Repository on Release Branch
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ github.ref_name }}
+          fetch-depth: 0
+
+      - name: Setup | Force release branch to be at workflow sha
+        run: |
+          git reset --hard ${{ github.sha }}
+
+      - name: Action | Semantic Version Release
+        id: release
+        # Adjust tag with desired version if applicable.
+        uses: python-semantic-release/python-semantic-release@v10.5.3
+        with:
+          config_file: releaserc.toml
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish | Upload to GitHub Release Assets
+        uses: python-semantic-release/publish-action@v10.5.3
+        if: steps.release.outputs.released == 'true'
+        with:
+          config_file: releaserc.toml
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}
+
+      - name: Upload | Distribution Artifacts
+        uses: actions/upload-artifact@v6
+        with:
+          name: distribution-artifacts
+          path: dist
+          if-no-files-found: error
+
+    outputs:
+      released: ${{ steps.release.outputs.released || 'false' }}
+
+  public-testpypi:
+    runs-on: ubuntu-latest
+    needs: release
+    if: ${{ needs.release.outputs.released == 'true' }}
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Setup | Download Build Artifacts
+        uses: actions/download-artifact@v7
+        id: artifact-download
+        with:
+          name: distribution-artifacts
+          path: dist
+
+      # see https://docs.pypi.org/trusted-publishers/
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+          print-hash: true
+          verbose: true
+          repository-url: https://test.pypi.org/legacy/
+
+  public-pypi:
+    runs-on: ubuntu-latest
+    needs: [public-testpypi, release]
+    if: ${{ needs.release.outputs.released == 'true' }}
+
+    permissions:
+      contents: read
+      id-token: write
+
+    environment:
+      name: production
+
+    steps:
+      - name: Setup | Download Build Artifacts
+        uses: actions/download-artifact@v7
+        id: artifact-download
+        with:
+          name: distribution-artifacts
+          path: dist
+
+      # see https://docs.pypi.org/trusted-publishers/
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+          print-hash: true
+          verbose: true

framex_kit-0.2.8/.github/workflows/secret-detection.yaml

@@ -0,0 +1,17 @@
+name: Secret Detection
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  detect:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: gitleaks/gitleaks-action@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

framex_kit-0.2.8/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test Project
+
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      PYTHON_VERSION: "3.11"
+      UV_VERSION: "0.5"
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Install UV
+        run: |
+          pip install uv==${{ env.UV_VERSION }}
+          uv sync --group dev
+      - name: Run Tests
+        run: uv run poe test-ci
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

framex_kit-0.2.8/.gitignore

@@ -0,0 +1,67 @@
+# Temporary and binary files
+*~
+*.py[cod]
+*.so
+*.cfg
+!setup.cfg
+*.orig
+*.log
+*.pot
+__pycache__/*
+.cache/*
+.*.swp
+*/.ipynb_checkpoints/*
+*.pyc
+
+# Project files
+.ropeproject
+.project
+.pydevproject
+.settings
+.idea
+.vscode
+
+# Package files
+*.egg
+*.eggs/
+.installed.cfg
+*.egg-info
+
+# Unittest and coverage
+htmlcov/*
+.coverage
+.tox
+junit.xml
+coverage.xml
+cov.xml
+report.xml
+.coverage.*
+**/cassettes
+
+# Build and docs folder/files
+build/*
+dist/*
+sdist/*
+docs/api/*
+docs/_build/*
+docs/build/*
+cover/*
+MANIFEST
+.mypy_cache/*
+
+# Unused code
+backup/*
+
+# macOS Desktop Services Store
+.DS_Store
+
+.history
+
+src/**demo
+
+# Config
+config.toml
+
+log
+data
+cache

framex_kit-0.2.8/.gitlab-ci.yml

@@ -0,0 +1,157 @@
+stages:
+  - test
+  - release
+  - deploy
+
+variables:
+  # Registry
+  CI_TEMPLATE_REGISTRY_HOST: "docker.io"
+  APT_SOURCE: "https://mirrors.aliyun.com"
+  GITLAB_SOURCE: ""
+
+  # Cache
+  PRE_COMMIT_HOME: "$CI_PROJECT_DIR/.pre-commit"
+  CARGO_HOME: $CI_PROJECT_DIR/cargo
+
+  # Pip
+  PIP_TIMEOUT: 30
+  PIP_RETRIES: 5
+  PIP_TRUSTED_HOST: ""
+  PYPI_URL: https://pypi.org/simple
+
+  # Python & UV
+  PYTHON_VERSION: "3.11"
+  UV_VERSION: "0.5"
+  UV_LINK_MODE: "copy"
+  UV_FROZEN: "true"
+
+# ⛓️ Shared templates
+.base_test_job_template: &base_test_job_template
+  stage: test
+  retry:
+    max: 2
+    when:
+      - runner_system_failure
+  tags:
+    - k8s_runner_persionnel_matching
+  rules:
+    - if: "$CI_COMMIT_MESSAGE =~ /^v/ || $CI_COMMIT_TAG"
+      when: never
+    - if: "$CI_COMMIT_BRANCH"
+
+.base_git_env_template: &base_git_env_template
+  before_script:
+    - |
+        rm -rf /var/lib/apt/lists/* /etc/apt/sources.list.d && \
+        echo "deb $APT_SOURCE/debian/ bookworm main" > /etc/apt/sources.list && \
+        echo "deb $APT_SOURCE/debian-security/ bookworm-security main" >> /etc/apt/sources.list && \
+        echo "deb $APT_SOURCE/debian/ bookworm-updates main" >> /etc/apt/sources.list && \
+        apt-get update -y && apt-get install -y --no-install-recommends git
+
+renovate:
+  image: ${CI_TEMPLATE_REGISTRY_HOST}/renovatebot/renovate:full
+  stage: test
+  variables:
+    RENOVATE_PLATFORM: gitlab
+    RENOVATE_ENDPOINT: $GITLAB_SOURCE
+    RENOVATE_TOKEN: $GITLAB_TOKEN
+    LOG_LEVEL: debug
+    RENOVATE_REPOSITORIES: "$CI_PROJECT_PATH"
+    RENOVATE_CACHE_NPM: "false"
+    RENOVATE_CACHE_PIP: "false"
+    RENOVATE_PYPI_PASS: "$PYPI_PASS"
+  script:
+    - renovate
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+      when: never
+    - if: '$CI_COMMIT_REF_NAME == "master" || $CI_COMMIT_REF_NAME == "main" || $CI_COMMIT_REF_NAME == "dev"'
+
+# 🔒 Secret scan
+include:
+  - template: Security/Secret-Detection.gitlab-ci.yml
+
+secret_detection:
+  <<: *base_test_job_template
+  allow_failure: false
+  script:
+    - /analyzer run
+    - cat gl-secret-detection-report.json
+
+# ✅ Pre-commit check
+check-pre-commit:
+  <<: *base_test_job_template
+  <<: *base_git_env_template
+  image: ${CI_TEMPLATE_REGISTRY_HOST}/library/python:3.11-slim
+  cache:
+    key: ${CI_PROJECT_ID}-pre-commit-cache
+    paths:
+      - $PRE_COMMIT_HOME
+  script:
+    - pip install pre-commit==4.2.0 -i $PYPI_URL
+    - |
+        pre-commit run --all-files --show-diff-on-failure
+
+# 🧪 Project test
+test-project:
+  <<: *base_test_job_template
+  image: ${CI_TEMPLATE_REGISTRY_HOST}/astral-sh/uv:${UV_VERSION}-python${PYTHON_VERSION}-bookworm-slim
+  cache:
+    key: ${CI_PROJECT_ID}-test-cache
+    paths:
+      - tests/api/cassettes
+  script:
+    - uv sync --group dev
+    - uv run poe test-ci
+  coverage: '/(?i)total.*? (100(?:\.0+)?%|[1-9]?\d(?:\.\d+)?%)$/'
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: cov.xml
+      junit: report.xml
+
+# 🚀 Semantic Release
+release:
+  <<: *base_git_env_template
+  image: ${CI_TEMPLATE_REGISTRY_HOST}/astral-sh/uv:${UV_VERSION}-python${PYTHON_VERSION}-bookworm-slim
+  stage: release
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+      when: never
+    - if: "$CI_COMMIT_MESSAGE =~ /^v/ || $CI_COMMIT_TAG"
+      when: never
+    - if: '$CI_COMMIT_REF_NAME == "master" || $CI_COMMIT_REF_NAME == "main" || $CI_COMMIT_REF_NAME == "dev"'
+  variables:
+    GIT_DEPTH: 0
+  before_script:
+    - !reference [.base_git_env_template, before_script]
+    - git checkout -B "$CI_COMMIT_REF_NAME" "origin/$CI_COMMIT_REF_NAME"
+    - git status
+  script:
+    - uv sync --extra release
+    - uv run poe release
+
+pages:
+  <<: *base_test_job_template
+  stage: deploy
+  image: ${CI_TEMPLATE_REGISTRY_HOST}/library/rust:latest
+  rules:
+    - if: '$CI_COMMIT_REF_NAME == "master" || $CI_COMMIT_REF_NAME == "main" || $CI_COMMIT_REF_NAME == "dev"'
+      changes:
+        - book/**/*
+  cache:
+    key: ${CI_PROJECT_ID}-pages-cache
+    paths:
+      - $CARGO_HOME
+  before_script:
+    - export PATH="$PATH:$CARGO_HOME/bin"
+    - cargo install mdbook
+    - cargo install mdbook-toc
+    - cargo install mdbook-katex
+    - cargo install mdbook-last-changed
+  script:
+    - cd book && mdbook build -d ../public
+  artifacts:
+    paths:
+      - public   

framex_kit-0.2.8/.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+default_stages: [pre-commit]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks.git
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+        args: ['--maxkb=500']
+      - id: check-toml
+      - id: check-yaml
+        args:
+          - "--unsafe"
+      - id: end-of-file-fixer
+      # - id: trailing-whitespace
+      - id: check-json
+      - id: debug-statements
+      - id: check-case-conflict
+      - id: detect-private-key
+      - id: name-tests-test
+        files: ^tests/(?!plugins/).+\.py$
+        exclude: ^tests/(consts|mock)\.py$
+        args:
+          - "--pytest-test-first"
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.10
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/codespell-project/codespell.git
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        files: \.(py|md|toml|yml|yaml|txt|rst)$
+
+  - repo: https://github.com/hukkin/mdformat
+    rev: 1.0.0
+    hooks:
+      - id: mdformat
+        files: ^(?!CHANGELOG\.md$).*\.(md|markdown)$
+        # Optionally add plugins
+        additional_dependencies:
+          - mdformat-gfm
+          - mdformat-black
+
+  - repo: https://github.com/ComPWA/taplo-pre-commit
+    rev: v0.9.3
+    hooks:
+      - id: taplo-format

framex_kit-0.2.8/.python-version

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