Merge branch 'main' into main

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Cache pip
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements*.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Install dependencies
+      run: |
+        pip install --upgrade pip
+        pip install -r requirements-dev.txt
+
+    - name: Run tests
+      run: |
+        pytest
+
+    #  Run pre-commit only on Python 3.13 + ubuntu.
+    - name: Run pre-commit hooks
+      if: ${{ matrix.python-version == '3.13' && matrix.os == 'ubuntu-latest' }}
+      run: |
+        pre-commit run --all-files

.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [created] # Trigger only when a release is created
+  workflow_dispatch: # Allows manual triggering of the workflow
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Step 1: Check out the code
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # Step 2: Set up Python
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+      # Step 3: Install dependencies for building and publishing
+      - name: Install build tools
+        run: |
+          pip install --upgrade pip
+          pip install build twine
+
+      # Step 4: Build the package
+      - name: Build the package
+        run: |
+          python -m build
+
+      # Step 5: Publish to PyPI
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          python -m twine check dist/*
+          python -m twine upload --skip-existing dist/*

.gitignore

@@ -131,6 +131,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.python-version
 
 # Spyder project settings
 .spyderproject

.pre-commit-config.yaml

@@ -0,0 +1,85 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      # Files
+      - id: check-added-large-files
+        description: "Prevent large files from being committed."
+        args: ["--maxkb=10000"]
+      - id: check-case-conflict
+        description: "Check for files that would conflict in case-insensitive filesystems."
+      - id: fix-byte-order-marker
+        description: "Remove utf-8 byte order marker."
+      - id: mixed-line-ending
+        description: "Replace mixed line ending."
+
+      # Links
+      - id: destroyed-symlinks
+        description: "Detect symlinks which are changed to regular files with a content of a path which that symlink was pointing to."
+
+      # File files for parseable syntax: python
+      - id: check-ast
+
+      # File and line endings
+      - id: end-of-file-fixer
+        description: "Ensure that a file is either empty, or ends with one newline."
+      - id: trailing-whitespace
+        description: "Trim trailing whitespace."
+
+      # Python
+      - id: check-docstring-first
+        description: "Check a common error of defining a docstring after code."
+      - id: requirements-txt-fixer
+        description: "Sort entries in requirements.txt."
+
+  - repo: https://github.com/MarcoGorelli/absolufy-imports
+    rev: v0.3.1
+    hooks:
+      - id: absolufy-imports
+        description: "Automatically convert relative imports to absolute. (Use `args: [--never]` to revert.)"
+
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.19.1
+    hooks:
+      - id: pyupgrade
+        description: "Automatically upgrade syntax for newer versions."
+        args: [--py3-plus, --py36-plus, --py38-plus, --py39-plus, --py310-plus]
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: python-check-blanket-noqa
+        description: "Enforce that `noqa` annotations always occur with specific codes. Sample annotations: `# noqa: F401`, `# noqa: F401,W203`."
+      - id: python-check-blanket-type-ignore
+        description: "Enforce that `# type: ignore` annotations always occur with specific codes. Sample annotations: `# type: ignore[attr-defined]`, `# type: ignore[attr-defined, name-defined]`."
+      - id: python-use-type-annotations
+        description: "Enforce that python3.6+ type annotations are used instead of type comments."
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        description: "Sort imports alphabetically, and automatically separated into sections and by type."
+
+  - repo: https://github.com/hadialqattan/pycln
+    rev: v2.4.0
+    hooks:
+      - id: pycln
+        description: "Remove unused import statements."
+
+  - repo: https://github.com/djlint/djLint
+    rev: v1.36.4
+    hooks:
+      - id: djlint-reformat-jinja
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.43.0
+    hooks:
+      - id: markdownlint
+        description: "Lint markdown files."
+        args: ["--disable=line-length"]

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[email protected].
+<[email protected]>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -114,15 +114,13 @@ the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
 version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
 
-[homepage]: https://www.contributor-covenant.org
-
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.