add pre-commit and linter

Author: mruiz-ledger

.github/workflows/ci.yml

@@ -31,7 +31,11 @@ jobs:
     - name: Build & install
       run: |
         pip install -U pip
-        pip install -U .
+        pip install -U .[dev]
+
+    - name: Lint
+      run: |
+        ruff check
 
   package-deploy:
     name: Build the Python package, and deploy if needed

.gitignore

@@ -2,5 +2,6 @@ build/
 dist/
 ledgerblue.egg-info/
 __pycache__
+.python-version
 
 __version__.py

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+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
+  # Ruff version.
+  rev: v0.3.7
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format

pyproject.toml

@@ -62,8 +62,12 @@ doc = [
     "sphinx_rtd_theme",
     "sphinx_argparse"
 ]
+dev = [
+    "pre-commit==3.2.0",
+    "ruff==0.3.7"
+]
 
 [tool.setuptools_scm]
 write_to = "ledgerblue/__version__.py"
 local_scheme = "no-local-version"
-fallback_version = "0.0.0"
+fallback_version = "0.0.0"

ruff.toml

@@ -0,0 +1,10 @@
+src = ["ledgerblue", "doc"]
+
+[lint]
+# Using rules from: pycodestyle, Pyflake and isort
+# INP001 __init__ files check on package
+select = [ "E", "F", "I", "INP001"]
+
+
+[lint.per-file-ignores]
+"!ledgerblue/*" = ["INP001"]