Merge pull request #6 from infocusp/hetul/add-ruff

Add ruff for automatic linting and formatting

.github/workflows/ruff.yaml

@@ -0,0 +1,20 @@
+name: Linting
+on: 
+  push:
+  pull_request:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+      # Update output format to enable automatic inline annotations.
+      - name: Run Ruff
+        run: ruff check --output-format=github .

.gitignore

@@ -1,2 +1 @@
-site/*
-.vscode/*
+site/*

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "charliermarsh.ruff"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "editor.rulers": [
+        80
+    ]
+}

contribute/CONTRIBUTION.md

@@ -57,6 +57,10 @@ Seminar Series. Make sure to read it before opening a PR.
 * Maintaining a consistent style across all the articles provides a good reading experience to our readers and often reduces review time.
 * We have provided code and text style guides [separately here](STYLE_GUIDES.md). 
 * You can refer them when crafting that perfect article.
+* Please use the following commands,
+    * Install ruff: `pip install -r requirements.txt`
+    * Run auto formatter: `ruff format`
+    * Run linter and fix remaining issues manually `ruff check`
 
 ### Step 7: Run the website locally
 

pyproject.toml

@@ -0,0 +1,21 @@
+[tool.ruff]
+lint.select = [
+  "D",    # pydocstyle
+  "E",    # pycodestyle
+  "F",    # pyflakes
+  "I",    # isort
+  "T201", # print
+  "E501"  # line-too-long
+]
+# Set the maximum line length to 79.
+line-length = 79
+
+# TODO(hetul): Fix the formatting and do not exclude this dir.
+exclude = ["./session_4/part_2_finetuning_lms_to_human_preferences/mingpt/*"]
+
+# Ignore import violations in all `__init__.py` files and missing docstring.
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["E402", "F401", "F403", "F811", "D104"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"