maidr 1.4.4__tar.gz → 1.4.8__tar.gz

maidr-1.4.8/.commitlintrc.cjs

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+  rules: {
+    "body-max-line-length": [0, "always", 0], // Disable line length checking for the body
+    "body-max-length": [0, "always", Infinity], // Disable total body length checking
+    "header-max-length": [0, "always", 0], // Disable header length checking
+    "footer-max-line-length": [0, "always", 0], // Disable line length checking for the footer
+    "footer-max-length": [0, "always", Infinity], // Disable total footer length checking
+  },
+};

maidr-1.4.8/.editorconfig

@@ -0,0 +1,17 @@
+# Check http://editorconfig.org for more information
+# This is the main config file for this project:
+root = true
+
+[*]
+charset = utf-8
+trim_trailing_whitespace = true
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+indent_size = 2
+
+[*.{rs,py,pyi}]
+indent_size = 4
+
+[*.md]
+max_line_length = 120

maidr-1.4.8/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "fix(): address an issue where "
+labels: bug
+assignees: ''
+---
+
+# Bug Report
+
+## Description
+<!-- Please provide a clear and concise description of the bug. -->
+
+## Steps to Reproduce
+
+1. Step 1
+2. Step 2
+3. Step 3
+
+## Actual Behavior
+<!-- Please describe what actually happened. -->
+
+## Expected Behavior
+<!-- Please describe what you expected to happen. -->
+
+## Screenshots
+<!-- If applicable, add screenshots to help explain the problem. -->
+<!-- You can take a gif animation screenshot very easily without any additional installation by using this browser-based tool: -->
+<!-- https://gifcap.dev -->
+
+## Environment
+- Operating System: [e.g. Windows 10]
+- Browser: [e.g. Chrome, Firefox]
+- Version: [e.g. 1.0.0]
+
+## Additional Information
+<!-- Add any other relevant information about the problem here. -->

maidr-1.4.8/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,37 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "feat: "
+labels: enhancement
+assignees: ''
+---
+
+# Feature Request
+
+## Description
+
+Please provide a clear and concise description of the feature you would like to request.
+
+## Motivation
+
+Explain why this feature is important and how it would benefit the project.
+
+## Proposed Solution
+
+Outline your proposed solution or any ideas you have for implementing this feature.
+
+## Additional Context
+
+<!-- Add any additional context or screenshots about the feature request here. -->
+<!-- If applicable, add screenshots to help explain the problem. -->
+<!-- You can take a gif animation screenshot very easily without any additional installation by using this browser-based tool: -->
+<!-- https://gifcap.dev -->
+
+
+## Checklist
+
+- [ ] I have searched for similar feature requests and confirmed that this is a new request.
+- [ ] I have provided a clear and concise description of the feature.
+- [ ] I have explained the motivation behind this feature request.
+- [ ] I have outlined a proposed solution or ideas for implementing this feature.
+- [ ] I have provided any additional context or screenshots if applicable.

maidr-1.4.8/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,53 @@
+<!-- Suggested PR Title: [feat/fix/refactor/perf/test/ci/docs/chore] brief description of the change -->
+<!-- Please follow Conventional Commits: https://www.conventionalcommits.org/en/v1.0.0/ -->
+
+## Description
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
+
+## Type of Change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] Any dependent changes have been merged and published in downstream modules
+
+# Pull Request
+
+## Description
+<!-- Provide a brief description of the changes made in this pull request. -->
+
+## Related Issues
+<!-- Specify any related issues or tickets that this pull request addresses. -->
+
+## Changes Made
+<!-- Describe the specific changes made in this pull request. -->
+
+## Screenshots (if applicable)
+<!-- Include any relevant screenshots or images to help visualize the changes. -->
+<!-- You can take a gif animation screenshot very easily without any additional installation by using this browser-based tool: -->
+<!-- https://gifcap.dev -->
+
+## Checklist
+<!-- Please select all applicable options. -->
+<!-- To select your options, please put an 'x' in the all boxes that apply. -->
+
+- [ ] I have read the [Contributor Guidelines](../CONTRIBUTING.md).
+- [ ] I have performed a self-review of my own code and ensured it follows the project's coding standards.
+- [ ] I have tested the changes locally following `ManualTestingProcess.md`, and all tests related to this pull request pass.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] I have updated the documentation, if applicable.
+- [ ] I have added appropriate unit tests, if applicable.
+
+## Additional Notes
+<!-- Add any additional notes or comments here. -->
+<!-- Template credit: This pull request template is based on Embedded Artistry {https://github.com/embeddedartistry/templates/blob/master/.github/PULL_REQUEST_TEMPLATE.md}, Clowder {https://github.com/clowder-framework/clowder/blob/develop/.github/PULL_REQUEST_TEMPLATE.md}, and TalAter {https://github.com/TalAter/open-source-templates} templates. -->

maidr-1.4.8/.github/copilot-instructions.md

@@ -0,0 +1,5 @@
+Always adhere to PEP 8 coding style guide.
+Always add NumPy-style docstring for all functions and classes.
+Include example section in the docstring if applicable.
+Always add type annotations
+Always add understandable comments.

maidr-1.4.8/.github/workflows/ci.yml

@@ -0,0 +1,86 @@
+name: CI
+
+on:
+  workflow_dispatch:
+
+  push:
+    branches-ignore:
+      - main
+    paths-ignore:
+      - "docs/**"
+      - "*.md"
+
+  pull_request:
+    paths-ignore:
+      - "docs/**"
+      - "*.md"
+
+jobs:
+  test:
+    # We want to run on external PRs, but not on our own internal PRs as they'll be run
+    # by the push to the branch. Without this if check, checks are duplicated since
+    # internal PRs match both the push and pull_request events.
+    if:
+      github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
+      github.repository
+
+    name: Python ${{ matrix.python-version }} tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Run tests
+        id: tests
+        run: uv run pytest -vvv
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Check format with ruff
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: "check --diff"
+          version: "0.3.4"
+
+  commit-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install commitlint dependencies
+        run: npm install @commitlint/config-conventional
+
+      - name: Lint commit messages
+        uses: wagoid/commitlint-github-action@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          failOnWarnings: 'false'
+          commitDepth: 1

maidr-1.4.8/.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Publish Quarto docs
+
+on:
+  workflow_dispatch:
+
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pages: write
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Run quartodoc
+        env:
+          PYTHONPATH: ${{ github.workspace }}
+        run: |
+          cd docs
+          uv run quartodoc build --verbose
+          uv run quartodoc interlinks
+
+      - name: Publish to GitHub Pages
+        uses: quarto-dev/quarto-actions/publish@v2
+        with:
+          target: gh-pages
+          path: docs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          QUARTO_PYTHON: .venv/bin/python

maidr-1.4.8/.github/workflows/release.yml

@@ -0,0 +1,129 @@
+name: Test & Release
+
+on:
+  workflow_dispatch:
+
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }} tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --locked --extra test --extra visualization
+
+      - name: Run tests
+        id: tests
+        run: uv run pytest -vvv
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Check format with ruff
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: "check --diff"
+          version: "0.3.4"
+
+  commit-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Lint commit messages
+        uses: wagoid/commitlint-github-action@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          failOnWarnings: 'false'
+          commitDepth: 1
+
+  release:
+    name: Semantic Release
+    runs-on: ubuntu-latest
+    concurrency: push
+    needs: [test, lint, commit-lint]
+    if: github.repository == 'xability/py-maidr'
+    environment:
+      name: pypi
+      url: https://pypi.org/project/maidr/
+    permissions:
+      # https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#metadata
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.ref_name }}
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Python Semantic Release
+        id: release
+        uses: python-semantic-release/python-semantic-release@v9.21.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          verbosity: 3
+          changelog: true
+          commit: true
+          push: true
+
+      - name: Build and publish package distributions to PyPI
+        id: pypi-publish
+        # NOTE: DO NOT wrap the conditional in ${{ }} as it will always evaluate to true.
+        # See https://github.com/actions/runner/issues/1173
+        if: steps.release.outputs.released == 'true'
+        run: |
+          # Use a clean environment for building
+          uv build --no-cache
+          uv publish
+
+      - name: Publish package distributions to GitHub Releases
+        id: github-release
+        # NOTE: DO NOT wrap the conditional in ${{ }} as it will always evaluate to true.
+        # See https://github.com/actions/runner/issues/1173
+        if: steps.release.outputs.released == 'true'
+        uses: python-semantic-release/upload-to-gh-release@main
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}
+          root_options: "-vv"

maidr-1.4.8/.gitignore

@@ -0,0 +1,177 @@
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+.conda/*
+*.py[cod]
+*$py.class
+*.pyc
+
+# 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/
+junit/
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/
+
+# Vscode config files
+# .vscode/
+.vscode/launch.json
+
+# 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/
+
+.DS_Store
+
+/.quarto/
+
+/.luarc.json

maidr-1.4.8/.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.3.4"
+    hooks:
+      - id: ruff
+        args: [--fix]

maidr-1.4.8/.vscode/extensions.json

@@ -0,0 +1,44 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+  // List of extensions which should be recommended for users of this workspace.
+  "recommendations": [
+    "ms-python.python",
+    "ms-python.vscode-pylance",
+    "ms-python.black-formatter",
+    "ms-python.flake8",
+    "ms-python.isort",
+    "njpwerner.autodocstring",
+    "dbaeumer.vscode-eslint",
+    "github.vscode-pull-request-github",
+    "github.remotehub",
+    "visualstudioexptteam.vscodeintellicode",
+    "visualstudioexptteam.intellicode-api-usage-examples",
+    "ms-toolsai.jupyter",
+    "ms-toolsai.vscode-jupyter-cell-tags",
+    "ms-toolsai.jupyter-keymap",
+    "ms-toolsai.jupyter-renderers",
+    "ms-toolsai.vscode-jupyter-slideshow",
+    "github.vscode-github-actions",
+    "ms-vscode.vscode-github-issue-notebooks",
+    "ms-vsliveshare.vsliveshare",
+    "github.copilot",
+    "github.copilot-chat",
+    "ms-vscode.vscode-speech",
+    "posit.shinyuieditor",
+    "quarto.quarto",
+    "github.codespaces",
+    "usernamehw.errorlens",
+    "editorconfig.editorconfig",
+    "ms-azuretools.vscode-docker",
+    "ms-vscode-remote.remote-containers",
+    "vivaxy.vscode-conventional-commits",
+    "joshbolduc.commitlint",
+    "ms-python.debugpy",
+    "eamodio.gitlens",
+    "posit.shiny",
+    "charliermarsh.ruff"
+  ],
+  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+  "unwantedRecommendations": []
+}