Merge pull request #18 from Uninett/dev/add-precommit-and-ruff-format…

…ting

Add pre-commit and workflows for linting and formatting using ruff

.github/workflows/format.yml

@@ -0,0 +1,17 @@
+name: Verify formatting
+
+on:
+  push:
+    branches: master
+  pull_request:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    name: Verify Python formatting
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: astral-sh/ruff-action@v2
+      with:
+        args: "format --check"

.github/workflows/tox.yml

@@ -3,6 +3,14 @@ name: Python package
 on: [push, pull_request]
 
 jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    name: Lint Python
+    steps:
+    - uses: actions/checkout@v4
+    - uses: astral-sh/ruff-action@v2
+
+
   build:
 
     runs-on: ubuntu-latest

.gitignore

@@ -5,4 +5,6 @@
 build/
 dist/
 *.egg-info/
-!.github/
+!.github/
+!.gitignore
+!.pre-commit-config.yaml

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: mixed-line-ending
+    -   id: end-of-file-fixer
+        exclude: &exclude_pattern '^changelog.d/'
+    -   id: debug-statements
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.7.2
+    hooks:
+        # Run the linter
+    -   id: ruff
+        name: "Ruff linting"
+        args: [
+          '--output-format=full',
+          '--statistics'
+        ]
+        # Run the formatter
+    -   id: ruff-format
+        name: "Ruff formatting"

README.md

@@ -1,4 +1,6 @@
 # Argus API Client
+[![test badge](https://img.shields.io/github/actions/workflow/status/Uninett/pyargus/tox.yml?branch=master)](https://github.com/Uninett/pyargus/actions)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 This is the official Python client library for the 
 [Argus](https://github.com/Uninett/Argus) API server.
@@ -150,3 +152,17 @@ c = Client(api_root_url="https://argus.example.org/api/v2", token=tokenobj.token
 ## BUGS
 
 * Doesn't provide high-level error handling yet.
+
+## Development
+
+### Code style
+
+Pyargus uses *ruff* as a source code formatter. Ruff is part of the optional dev dependencies listed in
+[pyproject.toml](./pyproject.toml)
+
+A pre-commit hook will format new code automatically before committing.
+To enable this pre-commit hook, run
+
+```console
+$ pre-commit install
+```

pyproject.toml

@@ -19,9 +19,33 @@ dependencies = [
     "iso8601",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "build",
+    "coverage",
+    "ipython",
+    "isort",
+    "pre-commit",
+    "pytest",
+    "ruff",
+    "tox",
+    "twine",
+]
+
 [tool.setuptools.dynamic]
 version = {attr = "pyargus.VERSION"}
 
 [tool.setuptools.packages.find]
 where = ["src"]
 exclude = ["tests*"]
+
+[tool.ruff]
+line-length = 88
+extend-exclude = [
+    ".egg-info",
+]
+output-format = "full"
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F4", "F5", "F6", "F7", "F8", "F9"]
+ignore = ["F403", "F405"]

src/pyargus/api.py

@@ -1,4 +1,5 @@
 """Defines a low-level API interface for Argus using simple_rest_client"""
+
 from simple_rest_client.api import API
 from simple_rest_client.resource import Resource
 

src/pyargus/client.py

@@ -1,4 +1,5 @@
 """Slightly higher level Argus API client abstraction"""
+
 from __future__ import annotations
 
 from datetime import datetime

src/pyargus/models.py

@@ -11,8 +11,11 @@
 # need an explicit value to flag stateless incidents.
 class _STATELESS_TYPE:
     pass
+
+
 STATELESS = _STATELESS_TYPE()
 
+
 @dataclass
 class SourceSystem:
     """Class for describing an Argus Source system"""

tests/test_api.py

@@ -10,4 +10,4 @@ def test_connect_should_return_api_client():
 def test_api_client_with_bad_args_should_fail():
     client = api.connect("random", "token")
     with pytest.raises(Exception):
-        response = client.incidents.list_open_unacked()
+        client.incidents.list_open_unacked()