Merge pull request #4 from lincc-frameworks/ruff

Switch from pylint+black to ruff

.copier-answers.yml

@@ -6,8 +6,8 @@ author_name: LINCC Frameworks
 create_example_module: true
 custom_install: true
 enforce_style:
-- pylint
-- black
+- ruff_lint
+- ruff_format
 failure_notification: []
 include_benchmarks: true
 include_docs: true
@@ -21,3 +21,4 @@ python_versions:
 - '3.9'
 - '3.10'
 - '3.11'
+- '3.12'

.github/workflows/smoke-test.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
     steps:
     - uses: actions/checkout@v4

.github/workflows/testing-and-coverage.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
     steps:
     - uses: actions/checkout@v4

.pre-commit-config.yaml

@@ -43,48 +43,21 @@ repos:
     hooks:
       - id: check-github-workflows
         args: ["--verbose"]
-    # Analyze the src code style and report code that doesn't adhere.
-  - repo: local
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.2.1
     hooks:
-      - id: pylint
-        name: pylint (python files in src/)
-        entry: pylint
-        language: system
-        types: [python]
-        files: ^src/
-        args:
-          [
-            "-rn", # Only display messages
-            "-sn", # Don't display the score
-            "--rcfile=src/.pylintrc",
-          ]
-    # Analyze the tests code style and report code that doesn't adhere.
-  - repo: local
-    hooks:
-      - id: pylint
-        name: pylint (python files in tests/ and benchmarks/)
-        entry: pylint
-        language: system
-        types: [python]
-        files: ^(tests|benchmarks)/
-        args:
-          [
-            "-rn", # Only display messages
-            "-sn", # Don't display the score
-            "--rcfile=tests/.pylintrc",
-          ]
-    # Analyze the code style and report code that doesn't adhere.
-  - repo: https://github.com/psf/black
-    rev: 23.7.0
+      - id: ruff
+        name: Lint code using ruff; sort and organize imports 
+        types_or: [ python, pyi ]
+        args: ["--fix"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.2.1
     hooks:
-      - id: black-jupyter
-        name: Format code using black
-        types_or: [python, pyi, jupyter]
-        # It is recommended to specify the latest version of Python
-        # supported by your project here, or alternatively use
-        # pre-commit's default_language_version, see
-        # https://pre-commit.com/#top_level-default_language_version
-        language_version: python3.10
+      - id: ruff-format
+        name: Format code using ruff
+        types_or: [ python, pyi, jupyter ]
     # Analyze type hints and report errors.
   - repo: local
     hooks:

pyproject.toml

@@ -25,13 +25,12 @@ dependencies = [
 [project.optional-dependencies]
 dev = [
     "asv==0.6.1", # Used to compute performance benchmarks
-    "black", # Used for static linting of files
     "jupyter", # Clears output from Jupyter notebooks
     "mypy", # Used for static type checking of files
     "pre-commit", # Used to run checks before finalizing a git commit
-    "pylint", # Used for static linting of files
     "pytest",
     "pytest-cov", # Used to report total code coverage
+    "ruff", # Used for static linting of files
 ]
 
 [build-system]