Add CI

.github/workflows/lint.yml

@@ -0,0 +1,34 @@
+name: Lint
+
+on: pull_request
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}
+  cancel-in-progress: true
+
+env:
+  PYTHON_VERSION: '3.11'
+  PRECOMMIT_VERSION: '3.7.1'
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install pre-commit
+        run: pip install pre-commit==${{ env.PRECOMMIT_VERSION }}
+
+      - name: Cache pre-commit
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: precommit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files

.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: Test
+
+on: pull_request
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}
+  cancel-in-progress: true
+
+env:
+  PYTHON_VERSION: '3.11'
+  POETRY_VERSION: '1.8.3'
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: ${{ env.POETRY_VERSION }}
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-v1-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-root --only main,test
+
+      - name: Install library
+        run: poetry install --only main,test
+
+      - name: Run tests and generate coverage report
+        run: make coverage

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.4.6
+    hooks:
+      - id: ruff
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: pretty-format-json
+        args: [--autofix, --no-sort-keys]
+
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.368
+    hooks:
+    - id: pyright

pyproject.toml

@@ -1,3 +1,7 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
 [tool.poetry]
 name = "stormvogel"
 version = "0.1.0"
@@ -8,9 +12,14 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.12"
-black = "^24.4.2"
+
+[tool.poetry.group.lint.dependencies]
+pre-commit = "^3.7.1"
+ruff = "^0.4.6"
 pyright = "^1.1.368"
 
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+[tool.ruff]
+src = ["stormvogel", "examples"]
+line-length = 88
+target-version = "py311"
+fix = true

stormvogel/__init__.py

@@ -1 +1 @@
-"""The stormvogel package"""
+"""The stormvogel package"""

stormvogel/model.py

@@ -208,7 +208,7 @@ def get_action(self, name: str) -> Action:
                 "Called get_action on a model that does not support actions"
             )
         assert self.actions is not None
-        if not name in self.actions:
+        if name not in self.actions:
             raise RuntimeError(
                 f"Tried to get action {name} but that action does not exist"
             )
@@ -258,7 +258,7 @@ def get_states_with(self, label: str):
 
     def get_state_by_id(self, state_id):
         """Get a state by its id."""
-        if not state_id in self.states:
+        if state_id not in self.states:
             raise RuntimeError("Requested a non-existing state")
         return self.states[state_id]
 

stormvogel/visualization.py

@@ -2,5 +2,6 @@
 
 from model import Model
 
-def show(m: Model) -> any:
+
+def show(m: Model):
     pass