General update to follow best practice

.github/CODEOWNERS

@@ -0,0 +1,13 @@
+# CODEOWNERS
+#
+# This file specifies which people or teams own code in this repository.
+# Directives are specified using one of the following forms:
+#
+#   * @org/team-name          # entire repo
+#   /path/to/file @user-name  # specific file
+#   /docs/**     @team-name   # all files in docs folder
+#   *.js         @js-owner    # all JS files
+#
+# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+#
+# Order is important; the last matching pattern takes precedence.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,28 @@
+name: "Bug Report"
+description: Report a bug
+title: "[Bug]: "
+labels: ["bug", "triage"]
+body:
+  - type: textarea
+    id: bug
+    attributes:
+      label: Bug description
+      description: Expected vs. actual behavior.
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: Minimal steps.
+      placeholder: |
+        1. ...
+        2. ...
+        See error.
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment (optional)
+      description: OS, Python, toolchain.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,20 @@
+name: "Feature Request"
+description: Suggest a feature
+title: "[Feature]: "
+labels: ["feature", "triage"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: What problem does it solve?
+      placeholder: I'm frustrated when...
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Solution
+      description: Describe the feature.
+    validations:
+      required: true

.github/dependabot.yml

@@ -0,0 +1,46 @@
+# Dependabot configuration file
+# Enables automated dependency updates for pip (individual PRs) and GitHub Actions (grouped PR).
+# Full documentation: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+
+updates:
+  # Pip dependencies from pyproject.toml ([project].dependencies and [dependency-groups])
+  - package-ecosystem: pip
+    directory: "/"
+    target-branch: "main"
+    schedule:
+      interval: "weekly"
+      # day: "monday"  # Optional: Restrict to specific weekday
+    open-pull-requests-limit: 5  # Limit number of open PRs
+    rebase-strategy: "auto"  # Options: auto, safe, noop
+    labels:
+      - "dependencies"
+    versioning-strategy: "increase"  # lockfile-only, increase, increase-if-necessary
+    # Useful: Ignore outdated/unwanted packages
+    # ignore:
+    #   - dependency-name: "legacy-package"
+    # Useful: Periodically update lockfile even without dep changes (requires lockfile)
+    # lockfile-maintenance:
+    #   enabled: true
+
+  # GitHub Actions in .github/workflows/*.yml
+  - package-ecosystem: "github-actions"
+    directory: "/"  # Root; scans .github/**/workflow yml files
+    target-branch: "main"
+    schedule:
+      interval: "monthly"
+      # day: "monday"
+    open-pull-requests-limit: 5
+    rebase-strategy: "auto"
+    labels:
+      - "CI"
+    groups:
+      gha-updates:
+        patterns:
+          - "*"  # Groups ALL GitHub Actions updates into single PR
+
+# Additional notes:
+# - Pip updates: Individual PRs per package (no group).
+# - Reviews: Uses .github/CODEOWNERS automatically.
+# - Automerge: Enable via branch protection rules or 'automerge: true' (experimental).

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+# PR Checklist
+
+- [ ] Tests pass
+- [ ] Docs if needed
+- [ ] pre-commit passes
+
+## Changes
+
+Brief description.
+
+## Related
+
+Closes #

.github/workflows/publish.yml

@@ -2,31 +2,30 @@ name: Publish WorkFlow
 
 on:
   release:
-    types: [created]
+    types: [published]
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [3.8]
     steps:
       - name: 🛎️ Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
         with:
-          ref: ${{ github.head_ref }}
-      - name: 🐍 Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: 🦾 Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install ".[dev]"
-      - name: 🚀 Publish to PyPi
-        env: 
-          PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-          PYPI_TEST_PASSWORD: ${{ secrets.PYPI_TEST_PASSWORD }}
+          python-version: "3.10"
+          cache: "pip"
+      - name: 🦾 Install build dependencies
         run: |
-          make publish -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -e PYPI_TEST_PASSWORD=$PYPI_TEST_PASSWORD
+          python -m pip install --upgrade pip build
+      - name: 📦 Build package
+        run: python -m build
+      - name: Upload to release
+        uses: AButler/[email protected]
+        with:
+          files: "dist/*"
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: 🚀 Publish to PyPI
+        uses: pypa/[email protected]
+        with:
+          password: ${{ secrets.PYPI_PASSWORD }}

.github/workflows/test.yml

@@ -9,22 +9,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
       - name: 🛎️ Checkout
-        uses: actions/checkout@v3
-        with:
-          ref: ${{ github.head_ref }}
+        uses: actions/checkout@v4
       - name: 🐍 Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+      - name: 🔧 Set up uv
+        uses: astral-sh/setup-uv@v5
       - name: 🦾 Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install ".[dev]"
-      - name: 🧹 Lint with flake8
-        run: |
-          make check_code_quality
+        run: uv sync --dev
       - name: 🧪 Test
-        run: "python -m pytest ./test"
+        run: uv run pytest test/ src/

.gitignore

@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# JetBrain IDE
+.idea/

.pre-commit-config.yaml

@@ -0,0 +1,57 @@
+# .pre-commit-config.yaml
+#
+# Pre-commit configuration for:
+# - Local git hooks: `pre-commit install` & `pre-commit run --all-files`
+# - pre-commit.ci bot: PR checks, auto hook updates, etc.
+#
+# Docs: https://pre-commit.ci/
+#
+ci:
+  autoupdate_schedule: monthly  # Monthly bot PRs to update hook revs
+  submodules: true  # Include git submodules in checks
+  autofix_commit_msg: |
+    [pre-commit.ci] auto fixes from pre-commit.com hooks
+    for more information, see https://pre-commit.ci  # Custom commit message for bot autofixes
+  skip: [~draft, ~WIP]  # Skip bot on PRs with these labels (regex prefix match)
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    # Basic file checks/fixes: whitespace, EOF, YAML/TOML validation, large files, security, symlinks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-docstring-first
+      - id: detect-private-key
+      - id: check-symlinks
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Python linter (ruff --fix) & formatter (ruff-format)
+    rev: v0.14.10
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
+  - repo: https://github.com/hukkin/mdformat
+    # Markdown formatter (mdformat)
+    rev: 1.0.0
+    hooks:
+      - id: mdformat
+  - repo: https://github.com/abravalheri/validate-pyproject
+    # Validate pyproject.toml schema/content
+    rev: v0.23
+    hooks:
+      - id: validate-pyproject
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    # Format pyproject.toml
+    rev: v2.9.0
+    hooks:
+      - id: pyproject-fmt
+  - repo: https://github.com/codespell-project/codespell
+    # Spell checker for code, comments, docs
+    rev: v2.4.1
+    hooks:
+      - id: codespell