Merge pull request #26 from LLMSQL/12-configure-precommit-hooks

pre commit config added; CONTRIBUTING.md updated

Author: DzmitryPihulski

.github/CODEOWNERS

@@ -1 +1 @@
-*       @DzmitryPihulski
+*       @DzmitryPihulski

.github/workflows/docs.yml

@@ -17,15 +17,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    
+
     - name: Setup Pages
       uses: actions/configure-pages@v4
-      
+
     - name: Upload artifact
       uses: actions/upload-pages-artifact@v3
       with:
         path: ./docs/_build
-        
+
     - name: Deploy to GitHub Pages
       id: deployment
-      uses: actions/deploy-pages@v4
+      uses: actions/deploy-pages@v4

.github/workflows/publish.yml

@@ -95,4 +95,4 @@ jobs:
     - name: Publish distribution to TestPyPI
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
-        repository-url: https://test.pypi.org/legacy/
+        repository-url: https://test.pypi.org/legacy/

.gitignore

@@ -6,4 +6,4 @@ dist/
 
 *.egg-info/
 .pdm-python
-.vscode
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,74 @@
+# Pre-commit hooks configuration
+# Setup: pre-commit install
+# Run manually: pre-commit run --all-files
+
+repos:
+  # Ruff
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      # Run the linter
+      - id: ruff
+        args: [--fix]
+        types_or: [python, pyi]
+      # Run the formatter
+      - id: ruff-format
+        types_or: [python, pyi]
+
+  # Mypy
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+        args: [--ignore-missing-imports, --check-untyped-defs]
+        files: ^llmsql/
+        additional_dependencies:
+          - types-PyYAML
+          - types-tqdm
+          - types-requests
+
+  # Run tests with pytest
+  - repo: local
+    hooks:
+      - id: pytest
+        name: pytest
+        entry: pytest
+        language: system
+        pass_filenames: false
+        always_run: true
+        args:
+          - tests/
+          - -v
+          - --tb=short
+        stages: [pre-commit]
+
+  # Standard pre-commit hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      # Check for files that would conflict in case-insensitive filesystems
+      - id: check-case-conflict
+      # Check for merge conflicts
+      - id: check-merge-conflict
+      # Check YAML syntax
+      - id: check-yaml
+      # Check TOML syntax
+      - id: check-toml
+      # Check for added large files
+      - id: check-added-large-files
+        args: [--maxkb=1000]
+      # Trim trailing whitespace
+      - id: trailing-whitespace
+      # Ensure files end with newline
+      - id: end-of-file-fixer
+      # Check JSON syntax
+      - id: check-json
+      # Check for debugger imports
+      - id: debug-statements
+
+# Configuration for specific hooks
+default_language_version:
+  python: python3.11
+
+# Run these hooks on every commit
+default_stages: [pre-commit]

CONTRIBUTING.md

@@ -28,6 +28,7 @@ pip3 install --user pdm
 git clone https://github.com/<YOUR_USERNAME>/llmsql-benchmark.git
 cd llmsql-benchmark
 pdm install --without default --with dev
+pre-commit install
 ```
 
 > **Note**: If you see `Command 'pdm' not found`, it usually means `~/.local/bin` is not on your `PATH`.
@@ -55,6 +56,7 @@ PYTHONPATH=. pdm run pytest --cov=llmsql --cov-report=xml --maxfail=1 --disable-
 
 Please run this command before any changes, just to make sure all code you forked works well by the time the development starts.
 
+Also to enable `pre-commit hooks` with `pre-commit install` command. Pre commit hooks contain pytest and will be run before each commit.
 
 ## Contribution Best Practices
 
@@ -90,4 +92,4 @@ There are a number of distinct ways to contribute to LLMSQL, and all are extreme
 - **Testing and devops** - We are very grateful for any assistance in adding tests for the library that can be run for new PRs, and other devops workflows.
 - **Proposing or Contributing New Features** - We want LLMSQL to be the best way to interact (evaluate) models on our benchmark. If you have a feature that is not currently supported but desired, feel free to open an issue describing the feature and, if applicable, how you intend to implement it. We would be happy to give feedback on the cleanest way to implement new functionalities and are happy to coordinate with interested contributors.
 
-We hope that this has been helpful, and appreciate your interest in contributing!
+We hope that this has been helpful, and appreciate your interest in contributing!

LICENSE

@@ -4,4 +4,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -21,7 +21,7 @@ Our datasets are available for different scenarios on our [HuggingFace page](htt
 pip3 install llmsql
 ```
 
-This repository provides the **LLMSQL Benchmark** — a modernized, cleaned, and extended version of WikiSQL, designed for evaluating and fine-tuning large language models (LLMs) on **Text-to-SQL** tasks. 
+This repository provides the **LLMSQL Benchmark** — a modernized, cleaned, and extended version of WikiSQL, designed for evaluating and fine-tuning large language models (LLMs) on **Text-to-SQL** tasks.
 
 ### Note
 The package doesn't have the dataset, it is stored on our [HuggingFace page](https://huggingface.co/llmsql-bench).
@@ -36,7 +36,7 @@ The package doesn't have the dataset, it is stored on our [HuggingFace page](htt
 
 ## Usage Recommendations
 
-Modern LLMs are already strong at **producing SQL queries without finetuning**.  
+Modern LLMs are already strong at **producing SQL queries without finetuning**.
 We therefore recommend that most users:
 
 1. **Run inference** directly on the full benchmark:
@@ -151,5 +151,3 @@ Please cite LLMSQL if you use it in your work:
   organization={IEEE}
 }
 ```
-
-

docs/_build/_sources/index.rst.txt

@@ -34,4 +34,3 @@ LLMSQL is a Python package for SQL reasoning with LLMs and vLLM inference.
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
-

docs/_build/_static/basic.css

@@ -903,4 +903,4 @@ div.math:hover a.headerlink {
     #top-link {
         display: none;
     }
-}
+}