ci: add ruff and flake8 linters GitHub workflow

Author: fguillot

.github/workflows/ci.yml

@@ -17,12 +17,6 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python3 -m pip install flake8
     - name: Unit tests
       run: |
         python3 -m unittest -v
-    - name: PEP8
-      run: |
-        flake8 --max-line-length 120

.github/workflows/linters.yml

@@ -0,0 +1,22 @@
+name: Linters
+on:
+  pull_request:
+    branches:
+      - main
+jobs:
+  linters:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff flake8
+      - name: Run Ruff
+        run: ruff check --output-format=github .
+      - name: Run Flake8
+        run: flake8 --max-line-length 120

.gitignore

@@ -1,8 +1,9 @@
+__pycache__
+.ruff_cache
 .venv
-*.pyc
 *.egg-info
 *.eggs
-dist
+*.pyc
 build
+dist
 MANIFEST
-__pycache__

tests/test_kanboard.py

@@ -29,37 +29,33 @@
 
 
 class TestClient(unittest.TestCase):
-
     def setUp(self):
-        self.url = 'some api url'
-        self.client = kanboard.Client(self.url, 'username', 'password')
+        self.url = "some api url"
+        self.client = kanboard.Client(self.url, "username", "password")
         self.request, self.urlopen = self._create_mocks()
 
     def ignore_warnings(test_func):
         def do_test(self, *args, **kwargs):
             with warnings.catch_warnings():
                 warnings.simplefilter("ignore")
                 test_func(self, *args, **kwargs)
+
         return do_test
 
     def test_api_call(self):
         body = b'{"jsonrpc": "2.0", "result": true, "id": 123}'
         self.urlopen.return_value.read.return_value = body
         self.assertEqual(True, self.client.remote_procedure())
-        self.request.assert_called_once_with(self.url,
-                                             data=mock.ANY,
-                                             headers=mock.ANY)
+        self.request.assert_called_once_with(self.url, data=mock.ANY, headers=mock.ANY)
 
     def test_custom_auth_header(self):
-        self.client._auth_header = 'X-Auth-Header'
+        self.client._auth_header = "X-Auth-Header"
         body = b'{"jsonrpc": "2.0", "result": true, "id": 123}'
         self.urlopen.return_value.read.return_value = body
         self.assertEqual(True, self.client.remote_procedure())
-        self.request.assert_called_once_with(self.url,
-                                             data=mock.ANY,
-                                             headers=mock.ANY)
+        self.request.assert_called_once_with(self.url, data=mock.ANY, headers=mock.ANY)
         _, kwargs = self.request.call_args
-        assert kwargs['headers']['X-Auth-Header'] == 'dXNlcm5hbWU6cGFzc3dvcmQ='
+        assert kwargs["headers"]["X-Auth-Header"] == "dXNlcm5hbWU6cGFzc3dvcmQ="
 
     def test_http_error(self):
         self.urlopen.side_effect = Exception()
@@ -70,7 +66,7 @@ def test_application_error(self):
         body = b'{"jsonrpc": "2.0", "error": {"code": -32603, "message": "Internal error"}, "id": 123}'
         self.urlopen.return_value.read.return_value = body
 
-        with self.assertRaises(kanboard.ClientError, msg='Internal error'):
+        with self.assertRaises(kanboard.ClientError, msg="Internal error"):
             self.client.remote_procedure()
 
     def test_async_method_call_recognised(self):
@@ -98,6 +94,6 @@ def test_async_call_generates_coro(self):
 
     @staticmethod
     def _create_mocks():
-        request_patcher = mock.patch('urllib.request.Request')
-        urlopen_patcher = mock.patch('urllib.request.urlopen')
+        request_patcher = mock.patch("urllib.request.Request")
+        urlopen_patcher = mock.patch("urllib.request.urlopen")
         return request_patcher.start(), urlopen_patcher.start()