refactor: migrate to ruff-only linting and add CI workflow

Author: Lujeni

.github/workflows/ci.yml

@@ -2,83 +2,39 @@ name: CI
 
 on:
   push:
-    branches:
-      - main
   pull_request:
-    branches:
-      - main
 
 jobs:
-  test:
+  lint:
+    name: Lint with ruff
+    runs-on: ubuntu-latest
     strategy:
-      fail-fast: false
       matrix:
-        python-version: [ '3.10', '3.11', '3.12', '3.13' ]
-        os: [ ubuntu-latest ]
-        vaultwarden-version: [ '1.32.7', '1.33.2' , '1.34.3']
-    runs-on: ${{ matrix.os }}
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v3
-        with:
-          lfs: true
-      - name: Setup Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade hatch
-      - name: Run Vaultwarden server
-        run: |
-          temp_dir=$(mktemp -d)
-          cp ${{ github.workspace }}/tests/fixtures/server/* $temp_dir
-          docker run -d --name vaultwarden -v $temp_dir:/data  --env I_REALLY_WANT_VOLATILE_STORAGE=true --env ADMIN_TOKEN=admin  --restart unless-stopped -p 80:80 vaultwarden/server:${{ matrix.vaultwarden-version }}
-      - name: Run tests
-        run: |
-          hatch run +py=${{ matrix.py || matrix.python-version }} test:with-coverage
-        env:
-          VAULTWARDEN_URL: "http://127.0.0.1:80"
-          VAULTWARDEN_ADMIN_TOKEN: "admin"
-          BITWARDEN_URL: "http://127.0.0.1:80"
-          BITWARDEN_EMAIL: "test-account@example.com"
-          BITWARDEN_PASSWORD: "test-account"
-          BITWARDEN_CLIENT_ID: "user.a8be340c-856b-481f-8183-2b7712995da2"
-          BITWARDEN_CLIENT_SECRET: "ag66paVUq4h7tBLbCbJOY5tJkQvUuT"
-          BITWARDEN_TEST_ORGANIZATION: "cda840d2-1de0-4f31-bd49-b30dacd7e8b0"
-          BITWARDEN_DEVICE_ID: "e54ba5f5-7d58-4830-8f2b-99194c70c14f"
+      - name: Install hatch
+        run: pip install hatch
+      - name: Run ruff check
+        run: hatch run style:check
 
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Setup Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.13'
-      - name: Install Python dependencies
-        run: |
-          python -m pip install --upgrade hatch
-      - name: Check with black + isort
-        if: always()
-        run: hatch run style:format && git diff --exit-code
-      - name: Check with ruff
-        if: always()
-        run: hatch run style:lint
-      - name: Check with mypy
-        if: always()
-        run: hatch run types:check
-
-  package:
+  test:
+    name: Test
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v3
-      - name: Setup Python
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
-      - name: Install Hatch
-        run: |
-          python -m pip install -U hatch
-      - name: Build package
-        run: |
-          hatch build
+          python-version: ${{ matrix.python-version }}
+      - name: Install hatch
+        run: pip install hatch
+      - name: Run tests
+        run: hatch run test:test

README.md

@@ -134,13 +134,38 @@ You can now install the project and its dependencies using:
 ```bash
 pip install -e .[test]
 ```
+
+### Code Style and Linting
+
+This project uses [ruff](https://docs.astral.sh/ruff/) for both linting and code formatting. Before submitting a pull request, ensure your code follows the project's style guidelines.
+
+To check for linting and formatting issues:
+```bash
+hatch run style:check
+```
+
+To automatically fix linting issues and format your code:
+```bash
+hatch run style:format
+```
+
+To only run linting (with auto-fix):
+```bash
+hatch run style:lint
+```
+
 ### Testing
 To run the tests, use:
 
 ```bash
 bash tests/e2e/run_tests.sh
 ```
 
+Or using hatch:
+```bash
+hatch run test:test
+```
+
 ## License
 
 Python-vaultwarden is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

pyproject.toml

@@ -93,51 +93,47 @@ check = "mypy src/vaultwarden"
 [tool.hatch.envs.style]
 detached = true
 dependencies = [
-    "black",
-    "isort",
     "ruff",
 ]
 [tool.hatch.envs.style.scripts]
 lint = [
-    "ruff check --fix src/vaultwarden",
+    "ruff check --fix src/vaultwarden tests",
 ]
 check = [
-    "isort --check-only --diff src/vaultwarden",
-    "black -q --check --diff src/vaultwarden",
-    "ruff check src/vaultwarden",
+    "ruff check src/vaultwarden tests",
+    "ruff format --check src/vaultwarden tests",
 ]
 format = [
-    "isort -q src/vaultwarden",
-    "black -q src/vaultwarden",
-    "lint"
+    "ruff format src/vaultwarden tests",
+    "lint",
 ]
 
 [tool.ruff]
-# Add "Q" to the list of enabled codes.
-select = ["B", "E", "F", "I", "N", "Q", "RUF", "SIM", "TCH"]
-ignore = ["N815"]
-fixable = ["ALL"]
 src = ["src/vaultwarden", "tests"]
 exclude = ["src/vaultwarden/utils/crypto.py"]
 target-version = "py310"
 line-length = 79
 
-[tool.ruff.flake8-quotes]
+[tool.ruff.lint]
+# Add "Q" to the list of enabled codes.
+select = ["B", "E", "F", "I", "N", "Q", "RUF", "SIM", "TCH"]
+ignore = ["N815"]
+fixable = ["ALL"]
+
+[tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"
 
-[tool.ruff.flake8-bugbear]
+[tool.ruff.lint.flake8-bugbear]
 extend-immutable-calls = ["typer.Argument"]
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 force-sort-within-sections = true
 
-[tool.black]
-line-length = 79
-target-version = ["py310", "py311"]
-
-[tool.isort]
-profile = "black"
-line_length = 80
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
 
 [tool.mypy]
 ignore_missing_imports = true

src/vaultwarden/clients/bitwarden.py

@@ -34,9 +34,7 @@ def __init__(
         self._http_client = Client(
             base_url=f"{self.url}/",
             event_hooks={"response": [log_raise_for_status]},
-            headers={
-                "Bitwarden-Client-Version": "2024.1.0"
-            },
+            headers={"Bitwarden-Client-Version": "2024.1.0"},
             timeout=timeout,
         )
         self._connect_token: ConnectToken | None = None

src/vaultwarden/models/sync.py

@@ -84,9 +84,10 @@ class UserProfile(PermissiveBaseModel):
     Providers: list
     SecurityStamp: str
     TwoFactorEnabled: bool
+    # original Bitwarden doesn't support disabling users
     status: VaultwardenUserStatus = Field(
-        default=VaultwardenUserStatus.Enabled, # original Bitwarden doesn't support disabling users
-        validation_alias=AliasChoices("_status", "_Status")
+        default=VaultwardenUserStatus.Enabled,
+        validation_alias=AliasChoices("_status", "_Status"),
     )
 
 

tests/models/validation/test_bitwarden_models.py

@@ -1,12 +1,11 @@
 import unittest
 
 from pydantic import TypeAdapter
-
 from vaultwarden.models.bitwarden import (
+    CollectionUser,
     Organization,
-    ResplistBitwarden,
     OrganizationUserDetails,
-    CollectionUser,
+    ResplistBitwarden,
 )
 
 

tests/models/validation/test_pascal_camel_cases.py

@@ -1,12 +1,11 @@
 import unittest
 
 from pydantic import TypeAdapter
-
 from src.vaultwarden.models.sync import SyncData, VaultwardenUser
 from vaultwarden.models.bitwarden import (
     Organization,
-    ResplistBitwarden,
     OrganizationCollection,
+    ResplistBitwarden,
 )
 
 

tests/models/validation/test_vaultwarden_models.py

@@ -1,7 +1,6 @@
 import unittest
 
 from pydantic import TypeAdapter
-
 from vaultwarden.models.sync import VaultwardenUser