Linters

.github/workflows/lint-project.yml

@@ -0,0 +1,32 @@
+name: Run Pre-Commit Hooks
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  pre-commit:
+    name: Pre-commit checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+      - name: Install pre-commit
+        run: |
+          python -m pip install --upgrade pip
+          pip install pre-commit
+      - name: Run pre-commit
+        run: pre-commit run --all-files

.github/workflows/test-project.yml

@@ -3,9 +3,9 @@ name: Scadable Tests
 on:
   pull_request:
     types: [opened, synchronize, reopened, ready_for_review]
-  push:
-    branches:
-      - main
+#  push:
+#    branches:
+#      - main
 
 jobs:
   test:

.gitignore

@@ -182,9 +182,9 @@ cython_debug/
 .abstra/
 
 # Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
 #  you could uncomment the following to ignore the entire vscode folder
 # .vscode/
 
@@ -207,4 +207,4 @@ marimo/_lsp/
 __marimo__/
 
 # Pycharm files
-.idea
+.idea

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.13.0
+  hooks:
+    - id: ruff-check
+      args: [ --fix ]
+    - id: ruff-format

README.md

@@ -1 +1 @@
-# library-python
+# library-python

pyproject.toml

@@ -24,10 +24,11 @@ dependencies = [
 dev = [
     "pytest",
     "coverage",
-    "pytest-cov"
+    "pytest-cov",
+    "pre-commit"
 ]
 
 
 [project.urls]
 "Homepage" = "https://github.com/scadable/library-python"
-"Bug Tracker" = "https://github.com/scadable/library-python/issues"
+"Bug Tracker" = "https://github.com/scadable/library-python/issues"

src/scadable/__init__.py

@@ -1 +1 @@
-print("Hello World")
+print("Hello World")

tests/test_import.py

@@ -1,2 +1,2 @@
 def test_module_import():
-    import src.scadable
+    import src.scadable  # noqa