Merge pull request #19 from sruggier/pr/modernize

Use uv and pre-commit to run checks locally, and on GitHub Actions

Author: danmilon

.basedpyright/baseline.json

@@ -0,0 +1,21 @@
+name: Static analysis
+on: [push, pull_request]
+jobs:
+    static_analysis:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - name: Install uv
+              uses: astral-sh/setup-uv@v5
+              with:
+                  # This is pinned for reproducibility. It can be updated anytime
+                  # a new version of uv is released.
+                  version: 0.6.17
+            - name: "Set up Python"
+              uses: actions/setup-python@v5
+              with:
+                  python-version-file: "pyproject.toml"
+            - name: Install dependencies
+              run: uv sync --locked --all-extras --dev
+            - name: Run static checks
+              run: uv run pre-commit run --all-files

.github/workflows/ruff.yml

@@ -0,0 +1,29 @@
+name: test
+on: [push, pull_request]
+jobs:
+    check:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version:
+                    - "3.9"
+                    - "3.10"
+                    - "3.11"
+                    - "3.12"
+                    - "3.13"
+                    - "3.14"
+        env:
+            UV_PYTHON: ${{ matrix.python-version }}
+        steps:
+            - uses: actions/checkout@v4
+            - name: Install uv
+              uses: astral-sh/setup-uv@v5
+              with:
+                  # This is pinned for reproducibility. It can be updated anytime
+                  # a new version of uv is released.
+                  version: 0.6.17
+                  python-version: ${{ matrix.python-version }}
+            - name: Install dependencies
+              run: uv sync --locked --all-extras --dev
+            - name: Run py.test
+              run: uv run py.test colander_tools

.github/workflows/static-analysis.yml

@@ -1,3 +1,4 @@
+build
 *.egg-info
 
 __pycache__

.github/workflows/test.yml

@@ -0,0 +1,69 @@
+fail_fast: true
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v5.0.0
+      hooks:
+          - id: trailing-whitespace
+          - id: end-of-file-fixer
+            # This file is automatically written without a newline, and fixing it
+            # repeatedly would be a waste of time.
+            exclude: ".basedpyright/baseline.json"
+          - id: debug-statements
+          - id: check-docstring-first
+          - id: check-merge-conflict
+          - id: name-tests-test
+    - repo: local
+      hooks:
+          - id: uv-lock
+            name: uv lock
+            language: system
+            require_serial: true
+            files: (^|/)pyproject\.toml$
+            pass_filenames: false
+            entry: uv lock
+            args:
+                - --check
+
+          - id: ruff
+            name: ruff check
+            language: system
+            require_serial: true
+            types: [python]
+            entry: uv run ruff check
+            args:
+                - --fix
+                - --exit-non-zero-on-fix
+          - id: ruff-format
+            name: ruff format
+            language: system
+            require_serial: true
+            types: [python]
+            entry: uv run ruff format
+            args:
+                - --verbose
+
+          - id: pyproject-fmt
+            name: pyproject-fmt
+            language: system
+            files: (^|/)pyproject\.toml$
+            entry: uv run pyproject-fmt
+
+          - id: prospector
+            name: prospector
+            language: system
+            require_serial: true
+            types: [python]
+            entry: uv run prospector
+            args:
+                - --ignore-patterns='^(?!colander_tools)'
+                - --no-autodetect
+
+          - id: basedpyright
+            name: basedpyright
+            language: system
+            require_serial: true
+            types: [python]
+            entry: uv run basedpyright
+            args:
+                - --level
+                - error

.gitignore

@@ -0,0 +1,11 @@
+strictness: medium
+
+pylint:
+    disable:
+        # TODO: incrementally re-enable and fix each of these warnings
+        - consider-using-f-string
+        - disallowed-name
+        - raise-missing-from
+        - redefined-builtin
+        - super-with-arguments
+        - useless-object-inheritance

.pre-commit-config.yaml

@@ -14,13 +14,11 @@ license = "BSD-3-Clause"
 authors = [
     { name = "Platform.sh", email = "sayhello@platform.sh" },
 ]
-requires-python = ">=3.7"
+requires-python = ">=3.9"
 classifiers = [
     "Intended Audience :: Developers",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.7",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -36,10 +34,22 @@ dependencies = [
 
 urls.source = "https://github.com/platformsh/colander-tools"
 
-[tool.pyproject-fmt]
-indent = 4
-
 [dependency-groups]
 dev = [
+    "basedpyright~=1.29",
+    "pre-commit~=4.2",
+    "prospector~=1.16",
+    "pyproject-fmt~=2.5",
+    "pytest~=8.3",
     "ruff~=0.11.5",
 ]
+
+[tool.pyproject-fmt]
+indent = 4
+
+[tool.pyright]
+venvPath = "."
+venv = ".venv"
+include = [ "colander_tools" ]
+pythonVersion = "3.9"
+failOnWarnings = false