set up ruff

aviaryan · aviaryan · commit 081d8a31a44f · 2025-09-17T12:01:15.000+05:30
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,8 @@
+name: Ruff
+on: [ push, pull_request ]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
diff --git a/.gitignore b/.gitignore
@@ -12,5 +12,6 @@ wheels/
 *.wav
 
 # not using this
-requirements.txt 
+requirements.txt
+requirements*.txt
 .DS_Store
diff --git a/README.md b/README.md
@@ -48,6 +48,15 @@ https://github.com/user-attachments/assets/c1a1f4d8-dc97-40a3-8e49-0b31021e100b
     -   Press the `Control` key once to stop.
     -   The transcribed text will be instantly pasted to your active screen.
 
+## 👨🏻‍💻 Dev
+
+For linting and formatting -
+
+```sh
+uv run ruff check
+uv run ruff format
+```
+
 ## 🛠️ Common Issues
 
 ### 📋 Transcribed text isn't pasting
diff --git a/pyproject.toml b/pyproject.toml
@@ -12,3 +12,8 @@ dependencies = [
     "sounddevice>=0.5.2",
     "soundfile>=0.13.1",
 ]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.13.0",
+]
diff --git a/uv.lock b/uv.lock
