Add Ruff to project

Author: 31ch

Jenkinsfile

@@ -71,7 +71,8 @@ pipeline {
                         ),
                         flake8(pattern: 'build/flake8.txt'),
                         pyLint(pattern: 'build/pylint.txt'),
-                        myPy(pattern: 'build/mypy.txt')
+                        myPy(pattern: 'build/mypy.txt'),
+                        pyLint(pattern: 'build/ruff.txt', id: 'ruff', name: 'Ruff')
                     ]
                 )
             }

Jenkinsfile.groovy

@@ -56,7 +56,8 @@ node {
                     ),
                     flake8(pattern: 'build/flake8.txt'),
                     pyLint(pattern: 'build/pylint.txt'),
-                    myPy(pattern: 'build/mypy.txt')
+                    myPy(pattern: 'build/mypy.txt'),
+                    pyLint(pattern: 'build/ruff.txt', id: 'ruff', name: 'Ruff')
                 ]
             )
         }

README.md

@@ -25,6 +25,7 @@ The Python package is based on the following toolchain:
 * [Flake8](https://flake8.pycqa.org/en/latest/) for style guide enforcement
 * [mypy](https://mypy-lang.org/) for static type checking
 * [Pylint](https://www.pylint.org/) for static code analysis
+* [Ruff](https://docs.astral.sh/ruff/) for linting and code formatting
 * [pytest](https://docs.pytest.org/en/stable/) for test creation and execution
 
 

pyproject.toml

@@ -42,6 +42,7 @@ dev-dependencies = [
     "pytest",
     "pytest-cov",
     "pytest-mock",
+    "ruff",
     "sphinx",
     "sphinx-rtd-theme",
 ]
@@ -69,3 +70,11 @@ omit = [
 output = "build/test-coverage.xml"
 
 source_pkgs = ["python_training_project"]
+
+[tool.ruff]
+include = [
+    "pyproject.toml",
+    "src/**/*.py",
+    "tests/**/*.py"
+]
+output-format = "pylint"

src/python_training_project/__main__.py

@@ -1,6 +1,7 @@
 """
 The main entry point contains the command line interface.
 """
+
 import logging
 import sys
 
@@ -18,16 +19,17 @@ def cli():
     logging.basicConfig(
         stream=sys.stdout,
         level=logging.INFO,
-        format='%(asctime)s %(name)-16s %(levelname)-8s %(message)s')
+        format="%(asctime)s %(name)-16s %(levelname)-8s %(message)s",
+    )
 
 
-@cli.command(name='sum')
-@click.argument('a', type=float)
-@click.argument('b', type=float)
+@cli.command(name="sum")
+@click.argument("a", type=float)
+@click.argument("b", type=float)
 def cli_sum(a: float, b: float):
     """Show the sum of two numbers on the console."""
-    log.info('Sum of %f and %f is %f', a, b, sum(a, b))
+    log.info("Sum of %f and %f is %f", a, b, sum(a, b))
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     cli()

src/python_training_project/calculate.py

@@ -7,4 +7,5 @@ def sum(a: float, b: float) -> float:
     """Calculate the sum of two numbers."""
     return a + b
 
+
 # TODO: add more functions here

tools/lint-package.sh

@@ -16,14 +16,26 @@ if [ $? -ne 0 ]; then
     STATUS=1
 fi
 
+echo "Running mypy..."
+uv run --all-extras mypy src/python_training_project > build/mypy.txt
+if [ $? -ne 0 ]; then
+    STATUS=1
+fi
+
 echo "Running pylint..."
 uv run --all-extras pylint src/python_training_project --msg-template="{path}:{line}: [{msg_id}, {obj}] {msg} ({symbol})" > build/pylint.txt
 if [ $? -ne 0 ]; then
     STATUS=1
 fi
 
-echo "Running mypy..."
-uv run --all-extras mypy src/python_training_project > build/mypy.txt
+echo "Running ruff check..."
+uv run --all-extras ruff check > build/ruff.txt
+if [ $? -ne 0 ]; then
+    STATUS=1
+fi
+
+echo "Running ruff format..."
+uv run --all-extras ruff format --check
 if [ $? -ne 0 ]; then
     STATUS=1
 fi