Merge pull request #1 from 13Mai13/chore/add-hooks-and-checks

Chore/add hooks and checks

.github/workflows/ruff.yml

@@ -0,0 +1,27 @@
+name: Ruff Linting
+
+on:
+  push:
+    branches:
+      - main  # Run on pushes to the main branch
+  pull_request:
+    branches:
+      - main  # Run on pull requests targeting the main branch
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"  # Use Python 3.12
+
+      - name: Install Ruff
+        run: pip install ruff
+
+      - name: Run Ruff
+        run: ruff check .

.gitignore

@@ -174,3 +174,4 @@ cython_debug/
 
 .DS_Store
 /data
+/venv

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.6  # Use the latest version
+    hooks:
+      - id: ruff
+        args: [--fix]  # Automatically fix linting issues

README.md

@@ -1,5 +1,7 @@
 # inbox-search
 
+A search engine on top of my open browser tabs. 
+
 ## Setup
 
 ### Worktree
@@ -19,6 +21,21 @@ https://github.com/microsoft/graphrag | microsoft/graphrag: A modular graph-base
 https://poloclub.github.io/transformer-explainer/ | Transformer Explainer: LLM Transformer Model Visually Explained
 ```
 
+### Install dependencies
+
+```
+uv venv venv
+source venv/bin/activate  # On Windows: .\venv\Scripts\activate
+uv pip install -r requirements.txt
+```
+
+```
+pre-commit install
+pre-commit run --all-files
+```
+
+
+
 ## Project 
 
 ### Why? 

pyproject.toml

@@ -0,0 +1,8 @@
+[project]
+name = "inbox-search"
+version = "0.1.0"
+description = "A search engine on top of my open browser tabs"
+authors = [
+    { name = "mai", github = "13Mai13" }
+]
+dependencies = []