Linting workflow and pre-commit (#26)

* Added linting workflow, hopefully it works

* Testing linting workflow again

* New Branch for Linting Workflow

* Testing Linting workflow

* Allowing Lint.YML to run on push to linting_workflow

* Testing pre-commit and updated lint.yml to disregard legacy files

* disable fail-fast to see if other python versions will fail

* Using uv to install ruff dependency, using uv-cache and removing pip installation

* added new action to install virtual environment before attempting to install dependency

* Fixed missing run for uv venv

* attempting ruff check again now that is seems to work...

* Trying uvx

* Removed assume python 3.9 from ruff config in pyproject.toml

* New Branch for Linting Workflow

* Testing Linting workflow

* (after rebase) Allowing Lint.YML to run on push to linting_workflow

* Testing pre-commit and updated lint.yml to disregard legacy files

* disable fail-fast to see if other python versions will fail

* Using uv to install ruff dependency, using uv-cache and removing pip installation

* added new action to install virtual environment before attempting to install dependency

* Fixed missing run for uv venv

* attempting ruff check again now that is seems to work...

* (after rebase) Trying uvx

* Removed assume python 3.9 from ruff config in pyproject.toml

* fixing typos after rebase

* Installing Ruff before calling check; added precommit to uvlock

* Added verbose keyword to make clear that files are being checked

* Attempting to revert src/ tests/ and .gitignore to master current ver

* Readded release and testing default workflows to match master

* Readd changelog to match master

* restored old version of gitignore

* Fixing PR comments

* fix

* added mypy and ruff to a dependency group called lint

---------

Co-authored-by: Tyler Mathis <[email protected]>

Author: HugoOnghai

.github/workflows/lint.yml

@@ -5,4 +5,20 @@ on:
     branches: [master]
   pull_request:
     branches: [master]
+  workflow_dispatch:
+
 # TODO: setup linting with uv/ruff
+# informed by testing.yml and https://medium.com/@sidharthvijayakumar7/automating-pylint-in-github-workflow-80c84b2ff243 and ruff documentation
+jobs:
+  linting:
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set up the python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: '3.12'
+          version: "latest"
+
+      - name: Analyzing the code with ruff
+        run: uvx ruff check --output-format=github

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.12.4
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      types_or: [ python, pyi ]
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+      types_or: [python, pyi ]
+exclude: 'legacy'

.python-version

@@ -0,0 +1 @@
+3.11

pyproject.toml

@@ -22,6 +22,11 @@ dependencies = [
 [dependency-groups]
 dev = [
     "pytest>=8.4.1",
+    "pre-commit>=4.2.0",
+]
+lint = [
+    "mypy>=1.17.1",
+    "ruff>=0.12.7",
 ]
 
 [build-system]
@@ -38,3 +43,56 @@ packages = ["src/mp_cite"]
 [project.urls]
 Homepage = "https://github.com/materialsproject/MPCite"
 Issues = "https://github.com/materialsproject/MPCite/issues"
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    "legacy",
+    "notebooks",
+    "uv.lock"
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow NO unused variables to exist in the codebase. If underscore-prefixed unused variables are permissible, use this regex $^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+dummy-variable-rgx = "^$"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"