Merge pull request #18 from roskakori/16-change-to-uv-and-ruff

#16 Change to uv and ruff

Author: roskakori

.github/workflows/build.yaml

@@ -9,50 +9,51 @@ jobs:
     strategy:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
-    env:
-      MAIN_PYTHON_VERSION: "3.12"  # Same as Ubuntu 24 LTS
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-      - name: Load cached venv
-        id: cached-poetry-dependencies
-        uses: actions/cache@v3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+          # NOTE Using the "latest" version of uv is risky, but for the time being uv is updated
+          #  regularly, so a specific version would be outdated rather quickly. Once uv goes
+          #  version 1.0, this should be changed to something like ">=1 <2".
+          version: "latest"
       - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        if: steps.cached-uv-dependencies.outputs.cache-hit != 'true'
         run: |
-          poetry install --no-interaction
+          uv sync
       - name: Build sanpo package
         run: |
-          poetry build
+          uv build
       - name: Run the test suite
         run: |
-          poetry run pytest --cov=sanpo --cov-branch
-
+          uv run pytest --cov=sanpo --cov-branch
 
   check-style:
     runs-on: ubuntu-latest
     # Disable pre-commit check on main and production to prevent
-    # pull request merges to fail with "don't commit to branch".
+    # pull request merges to fail with don't commit to branch".
     if: github.ref != 'refs/heads/main'
     steps:
       - uses: actions/checkout@v4
-      - name: Install pre-commit
-        run: |
-          sudo apt-get install python3
-          python -m pip install --upgrade pip
-          pip install pre-commit
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: ".pre-commit-config.yaml"
+          # NOTE Using the "latest" version of uv is risky, but for the time being uv is updated
+          #  regularly, so a specific version would be outdated rather quickly. Once uv goes
+          #  version 1.0, this should be changed to something like ">=1 <2".
+          version: "latest"
+      - name: Set up Python
+        run: uv python install
       - name: Load cached pre-commit
         id: cached-pre-commit
         uses: actions/cache@v4
@@ -61,6 +62,6 @@ jobs:
           key: pre-commit-${{ runner.os }}-${{ hashFiles('.pre-commit-config.yaml') }}
       - name: Install pre-commit hooks
         if: steps.cached-pre-commit.outputs.cache-hit != 'true'
-        run: pre-commit install --install-hooks
+        run: uv run pre-commit install --install-hooks
       - name: Check coding style
-        run: pre-commit run --all-files
+        run: uv run pre-commit run --all-files

.gitignore

@@ -251,6 +251,7 @@ cython_debug/
 # End of https://www.toptal.com/developers/gitignore/api/python,pycharm
 
 .DS_Store
+/.idea/misc.xml
 /.idea/ruff.xml
 /tests/temp
 !/tests/temp/.keep

.idea/misc.xml

@@ -1,40 +1,31 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
 exclude: "^.idea"
 
 repos:
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.10.1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.0
     hooks:
-      - id: isort
+      - id: ruff
+        args: ["--fix"]
+      - id: ruff-format
 
-  - repo: https://github.com/psf/black
-    rev: 24.10.0
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
     hooks:
-      - id: black
+      - id: prettier
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
+      - id: fix-byte-order-marker
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: mixed-line-ending
-      - id: check-yaml
-      - id: check-xml
       - id: check-added-large-files
       - id: check-ast
-      - id: debug-statements
-      - id: fix-byte-order-marker
+      - id: check-json
       - id: check-merge-conflict
-
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.0
-    hooks:
-      - id: pyupgrade
-        args: ["--py39-plus"]
-
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.1
-    hooks:
-      - id: flake8
-        additional_dependencies: ["pep8-naming==0.13.3"]
+      - id: check-xml
+      - id: check-yaml
+      - id: debug-statements
+      - id: no-commit-to-branch
+        args: ["--branch", "main"]

.idea/sanpo.iml

@@ -1,5 +1,10 @@
 # Changes
 
+Version 0.2.3, 2025-ß3-25
+
+- Change build and packaging to uv (#16)
+- Change linting to ruff (#16)
+
 Version 0.2.2, 2024-12-10
 
 - Remove support for Python 3.8 and update dependencies (#14)

.pre-commit-config.yaml

@@ -5,44 +5,41 @@
 To set up a developer environment perform the following steps:
 
 1. Check out the source code and change into its folder.
-2. Set up the [poetry](https://python-poetry.org/) environment:
+2. Install [uv](https://docs.astral.sh/uv/).
+3. Set up the virtual environment and pre-commit hooks:
    ```bash
-   poetry install
-   ```
-3. Set up the [pre-commit](https://pre-commit.com/) checks:
-   ```bash
-   poetry run pre-commit install --install-hooks
+   sh scripts/set_up_project.sh
    ```
 
 ## Testing
 
 To run the test suite:
 
 ```bash
-poetry run pytest
+uv run pytest
 ```
 
 ## Publishing a release
 
 1. Update the version number in `pyproject.toml`:
    ```toml
-   [tool.poetry]
+   [project]
    name = "sanpo"
    version = "0.x.x"
    ```
 2. Test and build the distribution archives:
    ```bash
-   $ poetry run pytest
-   $ poetry build
+   $ uv run pytest
+   $ uv build
    ```
-3. Tag a release (simply replace 0.9.x with the current version number):
+3. Tag a release (simply replace 0.x.x with the current version number):
    ```bash
    $ git tag -a -m "Tag version 0.x.x" v0.x.x
    $ git push --tags
    ```
 4. Upload the release to PyPI:
    ```bash
-   $ poetry publish
+   $ uv publish
    ```
 5. Publish the related
    [GitHub release](https://github.com/roskakori/sanpo/releases/new).