erlab 3.5.1__tar.gz

erlab-3.5.1/.codecov.yml

@@ -0,0 +1,5 @@
+codecov:
+  branch: main
+comment:
+  behavior: once
+  require_changes: true

erlab-3.5.1/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,56 @@
+name: Bug report
+description: Create a report to help us improve.
+labels: [bug]
+assignees: [kmnhan]
+body:
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Description
+      description: |
+        Thanks for reporting a bug! Please describe what you were trying to get done.
+        Tell us what happened, what went wrong.
+    validations:
+      required: true
+
+  - type: textarea
+    id: what-did-you-expect-to-happen
+    attributes:
+      label: Expected behavior
+      description: |
+        A clear and concise description of what you expected to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    id: sample-code
+    attributes:
+      label: Minimal Complete Verifiable Example
+      description: |
+        Minimal, self-contained copy-pastable example that demonstrates the issue.
+        This will be automatically formatted into code, so no need for markdown backticks.
+      render: Python
+
+  - type: checkboxes
+    id: mvce-checkboxes
+    attributes:
+      label: MVCE confirmation
+      description: |
+        Please confirm that the bug report is in an excellent state, so we can understand & fix it quickly & efficiently. For more details, check out:
+
+        - [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
+        - [Craft Minimal Bug Reports](https://matthewrocklin.com/minimal-bug-reports)
+
+      options:
+        - label: Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue.
+        - label: Complete example — the example is self-contained, including all data and the text of any traceback.
+        - label: Verifiable example — the example copy & pastes into an IPython prompt, returning the result.
+        - label: New issue — a search of GitHub Issues suggests this is not a duplicate.
+        - label: Recent environment — the issue occurs with the latest version of erlab and its dependencies.
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: |
+        Add any other context about the problem here, including screenshots or a list of packages and versions installed if relevant.

erlab-3.5.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question or start a discussion
+    url: https://github.com/kmnhan/erlabpy/discussions
+    about: Ask and answer questions on the discussions page!

erlab-3.5.1/.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,36 @@
+name: Feature Request
+description: Suggest an idea for this project.
+labels: [enhancement]
+assignees: [kmnhan]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: |
+        Is your feature request related to a problem?
+        Please provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Possible solution
+      description: |
+        A clear and concise description of what you want to happen.
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: |
+        A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: |
+        Add any other context or screenshots about the feature request here.
+    validations:
+      required: false

erlab-3.5.1/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions:
+        patterns:
+          - "*"

erlab-3.5.1/.github/workflows/ci.yml

@@ -0,0 +1,129 @@
+name: Test
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+  workflow_dispatch:
+  schedule:
+    # Every friday at 22:00 UTC (Every saturday at 07:00 KST/JST)
+    - cron: "0 22 * * FRI"
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+env:
+  FORCE_COLOR: 1
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }} [${{ matrix.qt-api }}]
+    runs-on: ubuntu-latest
+    env:
+      DISPLAY: ":99.0"
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12"]
+        qt-api: ["pyqt6", "pyside6"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: tlambert03/setup-qt-libs@v1
+      - name: Setup for Qt testing
+        run: |
+          /sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -screen 0 1920x1200x24 -ac +extension GLX
+
+      - name: Install pytest and dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -v .[viz,io,perf,misc,dev] ${{ matrix.qt-api }}
+          python -m pip list
+          export QT_API=${{ matrix.qt-api }}
+
+      - name: Test with pytest
+        if: matrix.python-version != '3.12' || matrix.qt-api != 'pyside6'
+        run: |
+          python -u -m pytest -v
+
+      - name: Test with pytest with coverage
+        if: matrix.python-version == '3.12' && matrix.qt-api == 'pyside6'
+        run: |
+          python -u -m pytest -v --cov erlab --junitxml=junit.xml
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12' && matrix.qt-api == 'pyside6'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Upload test results to Codecov
+        if: ${{ matrix.python-version == '3.12' && matrix.qt-api == 'pyside6' && !cancelled() }}
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  mypy:
+    name: Static type checking
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install mypy and dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .[viz,io,perf,misc,dev] mypy[reports,faster-cache] pyqt6
+          python -m pip list
+
+      - name: Run mypy
+        run: mypy --install-types --non-interactive --html-report mypy-report .
+
+      - name: Upload mypy results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: mypy-report
+          path: mypy-report/
+          if-no-files-found: error
+
+  changelog:
+    name: Update changelog
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.repository == 'kmnhan/erlabpy'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install commitizen cz-changeup
+
+      - name: Generate changelog
+        run: |
+          cz changelog
+
+      - name: Commit and push changes
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add .
+          if ! git diff-index --quiet HEAD; then
+            git commit -m "chore: update changelog"
+            git push
+          else
+            echo "nothing to commit, working tree clean"
+          fi

erlab-3.5.1/.github/workflows/release.yml

@@ -0,0 +1,64 @@
+name: Release
+
+on:
+  workflow_dispatch:
+env:
+  FORCE_COLOR: 1
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    concurrency:
+      group: release
+    if: |
+      github.event_name == 'workflow_dispatch' &&
+      github.repository == 'kmnhan/erlabpy'
+    environment:
+      name: pypi
+      url: https://pypi.org/p/erlab
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Run commitizen
+        id: cz
+        uses: commitizen-tools/commitizen-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          changelog_increment_filename: body.md
+          extra_requirements: "cz-changeup"
+
+      - name: Build package distributions
+        id: build
+        if: env.REVISION != env.PREVIOUS_REVISION
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+          python -m pip install --upgrade build
+          python -m build
+
+      - name: Publish package distributions to PyPI
+        id: pypi-publish
+        if: env.REVISION != env.PREVIOUS_REVISION
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+
+      - name: Publish package distributions to GitHub Releases
+        id: github-release
+        if: env.REVISION != env.PREVIOUS_REVISION
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: "body.md"
+          tag_name: v${{ steps.cz.outputs.version }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: dist/*

erlab-3.5.1/.gitignore

@@ -0,0 +1,167 @@
+# macOS
+.DS_Store
+
+# 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/
+*.prof
+*.pstats
+*.pstats.png
+*.austin
+
+# 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/
+docs/source/generated
+
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+mypy-report/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted 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/
+
+# VS Code
+.vscode/*
+
+# Misc. files
+erlab.accessors.rst

erlab-3.5.1/.pre-commit-config.yaml

@@ -0,0 +1,61 @@
+ci:
+  autoupdate_commit_msg: "ci(pre-commit): pre-commit autoupdate"
+  autofix_commit_msg: "style: pre-commit auto fixes [...]"
+  autoupdate_schedule: monthly
+
+default_install_hook_types: [pre-commit, commit-msg]
+
+repos:
+  # Meta hooks
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
+
+  # Security & credential scanning/alerting
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-vcs-permalinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  # Pygrep hooks
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+      - id: text-unicode-replacement-char
+      - id: python-use-type-annotations
+
+  # Lint and format with ruff
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.8.6
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [--fix, --show-fixes]
+      # Run the formatter.
+      - id: ruff-format
+
+  # Commitizen
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.1.0
+    hooks:
+      - id: commitizen
+        additional_dependencies: [cz-changeup]
+      - id: commitizen-branch
+        additional_dependencies: [cz-changeup]
+        stages: [pre-push]

erlab-3.5.1/.readthedocs.yaml

@@ -0,0 +1,27 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt