Modernize project and migrate to uv/ruff (#1687)

* Migrate to uv

* Migrate to ruff

* Add ruff

* Update pre-commit

* Update

* Update dependabot configuration to specify package ecosystems

* Fix pytest version constraint in dev-dependencies

* Improve testing strategy

* Improve release workflow

* Remove redundant version bumping step in release workflow

* Update flake8 configuration to ignore unused imports

* Add ruff linter to the list of selected linters in configuration

* Update pre-commit configuration and refine mypy settings

* Improve readme

* Refine wording in README for clarity and consistency

Author: iMicknl

.devcontainer/devcontainer.json

@@ -7,21 +7,33 @@
 	// Features to add to the dev container. More info: https://containers.dev/features.
 	"features": {
 		"ghcr.io/devcontainers/features/github-cli:1": {},
-		"ghcr.io/devcontainers-contrib/features/poetry:2": {}
+		"ghcr.io/va-h/devcontainers-features/uv:1": {}
 	},
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "poetry config virtualenvs.in-project true && poetry install --with dev --no-interaction && . .venv/bin/activate && pre-commit install",
+	"postCreateCommand": "uv sync && uv run pre-commit install",
 	// Configure tool-specific properties.
 	"customizations": {
 		"vscode": {
 			"extensions": [
+				"GitHub.copilot-chat",
 				"ms-python.python",
-				"ms-python.black-formatter"
+				"ms-python.debugpy",
+				"charliermarsh.ruff",
+				"github.vscode-github-actions"
 			],
-			"settings": {
-				"python.defaultInterpreterPath": "./.venv/bin/python"
+			"python.testing.pytestArgs": [
+				"tests"
+			],
+			"python.testing.unittestEnabled": false,
+			"python.testing.pytestEnabled": true,
+			"[python]": {
+				"editor.formatOnSave": true,
+				"editor.defaultFormatter": "charliermarsh.ruff",
+				"editor.codeActionsOnSave": {
+					"source.organizeImports.ruff": "explicit"
+				}
 			}
 		}
 	}

.github/dependabot.yml

@@ -1,15 +1,20 @@
 version: 2
 updates:
-  - package-ecosystem: pip
+  - package-ecosystem: "uv"
     directory: "/"
     schedule:
       interval: "daily"
       time: "08:00"
     open-pull-requests-limit: 10
 
-  - package-ecosystem: github-actions
+  - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "daily"
       time: "08:00"
     open-pull-requests-limit: 10
+
+  - package-ecosystem: "devcontainers"
+    directory: "/"
+    schedule:
+      interval: weekly

.github/workflows/lint.yaml

@@ -0,0 +1,33 @@
+name: lint
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    name: "Python ${{ matrix.python-version }}"
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ matrix.python-version }}"
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run pre-commit
+        run: uv run pre-commit run --show-diff-on-failure --color=always --all-files

.github/workflows/main.yaml

@@ -1,4 +1,4 @@
-# This workflow will upload a Python Package using Poetry when a release is published
+# This workflow will upload the package to PyPi when a release is published
 
 name: Publish Python Package (PyPi)
 
@@ -12,32 +12,53 @@ jobs:
     environment: release
 
     permissions:
-      # IMPORTANT: this permission is mandatory for trusted publishing
+      # IMPORTANT: this permission is mandatory for trusted publishing via PyPi
       id-token: write
 
     steps:
       - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.x"
-      - name: Set up Poetry
-        uses: Gr1N/setup-poetry@v9
-      - name: Bump Poetry version
+
+      - name: Retrieve version from tag name
+        id: retrieve-version
+        run: |
+            tag=${{ github.event.release.tag_name }}
+            version_number=${tag#?}
+            echo version: $version_number
+            echo "version=$version_number" >> $GITHUB_OUTPUT
+
+      - name: Bump project version in pyproject.toml
+        run: |
+            VERSION=${{ steps.retrieve-version.outputs.version }}
+            uvx --from=toml-cli toml set --toml-path=pyproject.toml project.version $VERSION
+
+      - name: Add changes to current branch and tag
         run: |
-          tag=${{ github.event.release.tag_name }}
-          version_number=${tag#?}
-          poetry version $version_number
+            git config --local user.email "action@github.com"
+            git config --local user.name "GitHub Action"
+
+            git add pyproject.toml
+            git commit -m "Bump version to ${{ github.event.release.tag_name }}"
+
       - name: Commit changes
-        uses: EndBug/add-and-commit@v4
-        with:
-          message: "Bump version to ${{ github.event.release.tag_name }}"
-          add: "pyproject.toml"
-          ref: "main"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Build package distribution
         run: |
-          poetry build
-      - name: Publish package distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+            git add pyproject.toml
+            git commit -m "Bump package version to ${{ steps.retrieve-version.outputs.version }}."
+            git tag -f -a ${{ github.event.release.tag_name }} -m "Release ${{ steps.retrieve-version.outputs.version }}."
+            git push origin HEAD:main
+            git push origin -f ${{ github.event.release.tag_name }}
+
+      - name: Build package
+        run: |
+            uv build
+
+      - name: Publish package to PyPI
+        run: |
+            uv publish

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pytest:
+    name: "Python ${{ matrix.python-version }}"
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ matrix.python-version }}"
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest tests

.github/workflows/test.yml

@@ -1,42 +1,29 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
 repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.12.0
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+-   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
-      - id: check-json
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-json
         exclude: .devcontainer
-      - id: check-yaml
-      - id: trailing-whitespace
-      - id: end-of-file-fixer
-  - repo: local
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: local
     hooks:
-      - id: black
-        name: black
-        entry: black
-        language: system
-        types: [ python ]
-      - id: flake8
-        name: flake8
-        entry: flake8
-        language: system
-        types: [ python ]
-      - id: isort
-        name: isort
-        entry: isort
-        language: system
-        types: [ python ]
-      - id: pyupgrade
-        name: pyupgrade
-        entry: pyupgrade
-        args: ["--py310-plus"]
-        language: system
-        types: [ python ]
       - id: mypy
         name: mypy
         entry: mypy
         language: system
         types: [ python ]
-      - id: pylint
-        name: pylint
-        entry: pylint
-        language: system
-        types: [ python ]
+        exclude: tests

.pre-commit-config.yaml

@@ -1,13 +1,8 @@
 # Python client for OverKiz API
 
-<p align=left>
-    <a href="https://github.com/iMicknl/python-overkiz-api/actions"><img src="https://github.com/iMicknl/python-overkiz-api/workflows/CI/badge.svg"/></a>
-    <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" /></a>
-</p>
+A fully asynchronous and user-friendly API client for the OverKiz platform. This client enables interaction with smart devices connected to OverKiz, supporting multiple vendors such as Somfy TaHoma and Atlantic Cozytouch.
 
-A fully async and easy to use API client for the (internal) OverKiz API. You can use this client to interact with smart devices connected to the OverKiz platform, used by various vendors like Somfy TaHoma and Atlantic Cozytouch.
-
-This package is mainly used by Home Assistant Core, to offer the Overkiz integration. If you want to use this package in your own project, you can use the [following examples](#getting-started) to get started, or look at the [Home Assistant Code](https://github.com/home-assistant/core/tree/dev/homeassistant/components/overkiz) for more examples.
+This package is primarily used by Home Assistant Core to provide the Overkiz integration. If you wish to use this package in your own project, refer to the [examples below](#getting-started) or explore the [Home Assistant source code](https://github.com/home-assistant/core/tree/dev/homeassistant/components/overkiz) for additional usage examples.
 
 ## Supported hubs
 
@@ -143,16 +138,17 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-## Development
+## Contribute
+
+We welcome contributions! To get started with setting up this project for development, follow the steps below.
 
-### DevContainer (recommended)
+### Dev Container (recommended)
 
-If you use Visual Studio Code with Docker or GitHub CodeSpaces, you can leverage the available devcontainer. This will install all required dependencies and tools and has the right Python version available. Easy!
+If you use Visual Studio Code with Docker or GitHub Codespaces, you can take advantage of the included [Dev Container](https://code.visualstudio.com/docs/devcontainers/containers). This environment comes pre-configured with all necessary dependencies and tools, including the correct Python version, making setup simple and straightforward.
 
 ### Manual
-- Install Python 3.12
-- Install [poetry](https://python-poetry.org): `curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python`
-- Clone this repository
-- `cd python-overkiz-api`
-- Init the project: `poetry install`
-- Run `poetry run pre-commit install`
+
+- Ensure Python 3.12 is installed on your system.
+- Install [uv](https://docs.astral.sh/uv/getting-started/installation).
+- Clone this repository and navigate to it: `cd python-overkiz-api`
+- Initialize the project with `uv sync`, then run `uv run pre-commit install`