pyBDL 1.0.0__tar.gz

pybdl-1.0.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @AN0DA

pybdl-1.0.0/.github/workflows/pr_checks.yml

@@ -0,0 +1,150 @@
+---
+name: PR checks
+
+"on":
+  pull_request:
+    branches: [main]
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - edited
+    paths:
+      - "pybdl/**"
+      - "tests/**"
+      - "pyproject.toml"
+      - ".github/workflows/pr_checks.yml"
+
+concurrency:
+  group: pr-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+permissions: {}
+
+jobs:
+  conventional-pr:
+    name: Conventional PR title
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read  # action-semantic-pull-request: read PR title
+    steps:
+      - name: Check PR title
+        uses: amannn/action-semantic-pull-request@e32d7e603df1aa1ba07e981f2a23455dee596825  # v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  lint:
+    name: Linting (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@94527f2e458b27549849d47d273a16bec83a01e9  # v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        env:
+          UV_PYTHON_VERSION: ${{ matrix.python-version }}
+        run: uv python install "${UV_PYTHON_VERSION}"
+
+      - name: Install project (dev + extras)
+        run: uv sync --all-extras --dev
+
+      - name: Ruff linter
+        run: uv run ruff check --config pyproject.toml --output-format=github pybdl/ tests/
+
+      - name: Ruff formatter (check only)
+        run: uv run ruff format --config pyproject.toml --check pybdl/ tests/
+
+      - name: Bandit
+        run: uv run bandit -c pyproject.toml -r pybdl/
+
+  mypy:
+    name: Mypy (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@94527f2e458b27549849d47d273a16bec83a01e9  # v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        env:
+          UV_PYTHON_VERSION: ${{ matrix.python-version }}
+        run: uv python install "${UV_PYTHON_VERSION}"
+
+      - name: Install project (dev + extras)
+        run: uv sync --all-extras --dev
+
+      - name: Mypy
+        run: uv run mypy pybdl/ tests/
+
+  tests:
+    name: Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    needs:
+      - lint
+      - mypy
+      - conventional-pr
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    permissions:
+      contents: read
+      checks: write  # publish-unit-test-result-action: create check runs
+      pull-requests: write  # publish-unit-test-result-action: annotate PR
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@94527f2e458b27549849d47d273a16bec83a01e9  # v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        env:
+          UV_PYTHON_VERSION: ${{ matrix.python-version }}
+        run: uv python install "${UV_PYTHON_VERSION}"
+
+      - name: Install project (dev + extras)
+        run: uv sync --all-extras --dev
+
+      - name: Run tests with coverage
+        run: uv run coverage run -m pytest --junitxml=./test_results.xml
+
+      - name: Publish test results to GitHub
+        if: ${{ !cancelled() }}
+        uses: EnricoMi/publish-unit-test-result-action@2ceeed2b8f26e15b06c3846719f75354febd9e7b  # v2
+        with:
+          files: ./test_results.xml
+          fail_on: nothing
+          pull_request_build: commit

pybdl-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,272 @@
+---
+name: Release
+
+"on":
+  workflow_dispatch:
+
+permissions: {}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  quality-checks:
+    name: Quality checks (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@94527f2e458b27549849d47d273a16bec83a01e9  # v7
+        with:
+          enable-cache: false
+
+      - name: Set up Python ${{ matrix.python-version }}
+        env:
+          UV_PYTHON_VERSION: ${{ matrix.python-version }}
+        run: uv python install "${UV_PYTHON_VERSION}"
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run Ruff linter
+        if: ${{ !cancelled() }}
+        run: uv run ruff check --config pyproject.toml --output-format=github pybdl/ tests/
+
+      - name: Run Ruff formatter
+        if: ${{ !cancelled() }}
+        run: uv run ruff format --config pyproject.toml --check pybdl/ tests/
+
+      - name: Run Bandit security checks
+        if: ${{ !cancelled() }}
+        run: uv run bandit -c pyproject.toml -r pybdl/
+
+      - name: Run Mypy type checker
+        if: ${{ !cancelled() }}
+        run: uv run mypy pybdl/ tests/
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    permissions:
+      contents: read
+      checks: write  # publish-unit-test-result-action: create check runs
+      pull-requests: write  # publish-unit-test-result-action: annotate PR
+      id-token: write  # codecov-action: OIDC token when not using CODECOV_TOKEN
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@94527f2e458b27549849d47d273a16bec83a01e9  # v7
+        with:
+          enable-cache: false
+
+      - name: Set up Python ${{ matrix.python-version }}
+        env:
+          UV_PYTHON_VERSION: ${{ matrix.python-version }}
+        run: uv python install "${UV_PYTHON_VERSION}"
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run tests with coverage
+        run: uv run coverage run -m pytest --junitxml=./test_results.xml
+
+      - name: Generate coverage report
+        if: ${{ !cancelled() }}
+        run: |
+          uv run coverage report
+          uv run coverage xml
+
+      - name: Publish test results
+        uses: EnricoMi/publish-unit-test-result-action@2ceeed2b8f26e15b06c3846719f75354febd9e7b  # v2
+        if: ${{ !cancelled() }}
+        with:
+          files: ./test_results.xml
+          check_name: Test Results (Python ${{ matrix.python-version }})
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@75cd11691c0faa626561e295848008c8a7dddffe  # v5
+        with:
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false
+
+  release:
+    name: Semantic release
+    runs-on: ubuntu-latest
+    needs: [quality-checks, test]
+    if: github.ref == 'refs/heads/main'
+
+    environment: release
+
+    permissions:
+      contents: write  # semantic-release: tag, commit version bumps, push to main
+
+    outputs:
+      released: ${{ steps.release.outputs.released }}
+      version: ${{ steps.release.outputs.version }}
+      tag: ${{ steps.release.outputs.tag }}
+
+    steps:
+      - name: Generate GitHub App Token
+        id: app-token
+        uses: actions/create-github-app-token@fee1f7d63c2ff003460e3d139729b119787bc349  # v2
+        with:
+          app-id: ${{ vars.GH_APP_RW_ACCESS_APP_ID }}
+          private-key: ${{ secrets.GH_APP_RW_ACCESS_PRIVATE_KEY }}
+
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          fetch-depth: 0
+          token: ${{ steps.app-token.outputs.token }}
+          persist-credentials: true  # zizmor: ignore[artipacked]
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@94527f2e458b27549849d47d273a16bec83a01e9  # v7
+        with:
+          enable-cache: false
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Setup Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Python Semantic Release
+        id: release
+        uses: python-semantic-release/python-semantic-release@fb90716c1b3afbd1d88f48d7f88ba7365914a86e  # v10.5.2
+        with:
+          github_token: ${{ steps.app-token.outputs.token }}
+          verbosity: "2"
+
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    needs: release
+    if: needs.release.outputs.released == 'true'
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          ref: main
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@94527f2e458b27549849d47d273a16bec83a01e9  # v7
+        with:
+          enable-cache: false
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Build package
+        run: uv build
+
+      - name: Store distribution packages
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4  # v5
+        with:
+          name: python-package-distributions
+          path: dist/
+          retention-days: 7
+
+  publish-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [release, build]
+    if: needs.release.outputs.released == 'true'
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pybdl
+
+    permissions:
+      id-token: write  # Trusted publishing to PyPI
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0  # v5
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e  # release/v1
+
+  publish-github:
+    name: Upload to GitHub Release
+    runs-on: ubuntu-latest
+    needs: [release, build]
+    if: needs.release.outputs.released == 'true'
+
+    environment: release
+
+    permissions:
+      contents: write  # gh release upload: attach assets to GitHub Release
+      id-token: write  # sigstore/gh-action-sigstore-python: OIDC for signing
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0  # v5
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Sign distributions with Sigstore
+        uses: sigstore/gh-action-sigstore-python@f514d46b907ebcd5bedc05145c03b69c1edd8b46  # v3.0.0
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+
+      - name: Generate GitHub App Token
+        id: app-token
+        uses: actions/create-github-app-token@fee1f7d63c2ff003460e3d139729b119787bc349  # v2
+        with:
+          app-id: ${{ vars.GH_APP_RW_ACCESS_APP_ID }}
+          private-key: ${{ secrets.GH_APP_RW_ACCESS_PRIVATE_KEY }}
+
+      - name: Upload to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
+          RELEASE_TAG: ${{ needs.release.outputs.tag }}
+          GITHUB_REPOSITORY: ${{ github.repository }}
+        run: |
+          set -euo pipefail
+          shopt -s nullglob
+          assets=(dist/*.tar.gz dist/*.whl)
+          gh release upload "${RELEASE_TAG}" "${assets[@]}" --repo "${GITHUB_REPOSITORY}"

pybdl-1.0.0/.github/workflows/sphinx.yml

@@ -0,0 +1,80 @@
+---
+name: Docs
+
+"on":
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "pybdl/**"
+      - ".github/workflows/sphinx.yml"
+      - "pyproject.toml"
+  pull_request:
+    paths:
+      - "docs/**"
+      - "pybdl/**"
+      - ".github/workflows/sphinx.yml"
+      - "pyproject.toml"
+
+concurrency:
+  group: docs-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions: {}
+
+jobs:
+  build:
+    name: Build Sphinx docs
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@94527f2e458b27549849d47d273a16bec83a01e9  # v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install docs dependencies
+        run: uv sync --only-group docs
+
+      - name: Build HTML (fail on warnings)
+        run: >
+          uv run sphinx-build -W --keep-going -b html docs docs/_build/html
+
+      - name: Upload docs as artifact (PRs & pushes)
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4  # v5
+        with:
+          name: html-docs
+          path: docs/_build/html
+          retention-days: 7
+
+      - name: Upload GitHub Pages artifact (only main)
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b  # v4
+        with:
+          path: docs/_build/html
+
+  deploy:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write  # deploy-pages: publish to GitHub Pages
+      id-token: write  # deploy-pages: OIDC authentication with Pages
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e  # v4

pybdl-1.0.0/.gitignore

@@ -0,0 +1,198 @@
+### OSX template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.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/
+
+# Custom
+bdl_api_swagger.json
+.envrc
+.vscode/
+dev/
+.worktrees/