Merge branch 'dev' into feature/vincilb/agentsmd

Author: vawsgit

.editorconfig

@@ -0,0 +1,21 @@
+# This file is for EditorConfig and helps maintain consistent coding styles.
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab
+indent_size = 4
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true

.gitignore

@@ -2,8 +2,12 @@
 .vscode/settings.json
 **/__pycache__/
 **/*.egg-info/
+.venv/
 .coverage
 .ash/
+.temp/
+uv.lock
 
 .kiro/*
 .kiro/**/*
+

.vscode/settings.json.example

@@ -0,0 +1,18 @@
+{
+  "git.openRepositoryInParentFolders": "always",
+  "python.analysis.extraPaths": [],
+  "notebook.formatOnSave.enabled": true,
+  "notebook.codeActionsOnSave": {
+    "notebook.source.fixAll": "explicit",
+    "notebook.source.organizeImports": "explicit"
+  },
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
+      "source.organizeImports": "explicit"
+    },
+  },
+  "makefile.configureOnOpen": false
+}

Makefile

@@ -1,5 +1,11 @@
 # Simple Makefile for stickler
 
+# Define color codes for terminal output
+RED := \033[0;31m
+GREEN := \033[0;32m
+YELLOW := \033[1;33m
+NC := \033[0m  # No Color
+
 install:
 	pip install -e .
 
@@ -12,3 +18,23 @@ test:
 clean:
 	find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
 	find . -type f -name "*.pyc" -delete
+
+# Run linting checks and automatically fix issues
+lint:
+	ruff check --fix
+
+# CI/CD version of lint that only checks but doesn't modify files
+# Used in CI pipelines to verify code quality without making changes
+lint-cicd:
+	@echo "Running code quality checks..."
+	@if ! ruff check; then \
+		echo -e "$(RED)ERROR: Ruff linting failed!$(NC)"; \
+		echo -e "$(YELLOW)Please run 'make ruff-lint' locally to fix these issues.$(NC)"; \
+		exit 1; \
+	fi
+	@if ! ruff format --check; then \
+		echo -e "$(RED)ERROR: Code formatting check failed!$(NC)"; \
+		echo -e "$(YELLOW)Please run 'make format' locally to fix these issues.$(NC)"; \
+		exit 1; \
+	fi
+	@echo -e "$(GREEN)All code quality checks passed!$(NC)"

docs/docs/Contributing/code-style.md

@@ -26,6 +26,23 @@ ruff check --fix .
 ruff check src/stickler/comparators/
 ```
 
+### Automatic Formatting in VS Code
+
+To enable automatic code formatting and linting in VS Code:
+
+1. Copy the example settings file:
+   ```bash
+   cp .vscode/settings.json.example .vscode/settings.json
+   ```
+
+2. Install the Ruff extension for VS Code (if not already installed):
+   - Open VS Code
+   - Go to Extensions (Cmd+Shift+X on macOS, Ctrl+Shift+X on Windows/Linux)
+   - Search for "Ruff" by Charlie Marsh
+   - Click Install
+
+The settings file configures VS Code to automatically format Python files on save and organize imports using Ruff.
+
 ### CI Integration
 
 Linting runs automatically on every push and pull request via GitHub Actions. While currently non-blocking, you should address linting issues before submitting PRs.

examples/notebooks/Complex_nested_structure.ipynb

@@ -28,13 +28,14 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from typing import Optional, List\n",
-    "from stickler.structured_object_evaluator.models.structured_model import StructuredModel\n",
-    "from stickler.structured_object_evaluator.models.comparable_field import ComparableField\n",
+    "import json\n",
+    "from typing import List, Optional\n",
+    "\n",
+    "from stickler.comparators.exact import ExactComparator\n",
     "from stickler.comparators.levenshtein import LevenshteinComparator\n",
     "from stickler.comparators.numeric import NumericComparator\n",
-    "from stickler.comparators.exact import ExactComparator\n",
-    "import json"
+    "from stickler.structured_object_evaluator.models.comparable_field import ComparableField\n",
+    "from stickler.structured_object_evaluator.models.structured_model import StructuredModel"
    ]
   },
   {

examples/notebooks/Custom_Comparator_Demo.ipynb

@@ -40,21 +40,22 @@
     }
    ],
    "source": [
-    "import sys\n",
     "import os\n",
+    "import sys\n",
     "\n",
     "# Add the src directory to path so we can import stickler\n",
     "sys.path.insert(0, os.path.join(os.path.dirname(os.getcwd()), \"src\"))\n",
     "\n",
     "from typing import Any\n",
+    "\n",
     "import pandas as pd\n",
     "\n",
     "# Import stickler library components\n",
     "from stickler.comparators.base import BaseComparator\n",
     "from stickler.comparators.exact import ExactComparator\n",
     "from stickler.comparators.levenshtein import LevenshteinComparator\n",
-    "from stickler.structured_object_evaluator.models.structured_model import StructuredModel\n",
     "from stickler.structured_object_evaluator.models.comparable_field import ComparableField\n",
+    "from stickler.structured_object_evaluator.models.structured_model import StructuredModel\n",
     "\n",
     "print(\"✓ Successfully imported stickler library components\")"
    ]

examples/notebooks/Quick_start.ipynb

@@ -28,10 +28,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from stickler.structured_object_evaluator.models.structured_model import StructuredModel\n",
-    "from stickler.structured_object_evaluator.models.comparable_field import ComparableField\n",
+    "from typing import List\n",
+    "\n",
     "from stickler.comparators.levenshtein import LevenshteinComparator\n",
-    "from typing import List"
+    "from stickler.structured_object_evaluator.models.comparable_field import ComparableField\n",
+    "from stickler.structured_object_evaluator.models.structured_model import StructuredModel"
    ]
   },
   {

examples/scripts/aggregate_metrics_demo.py

@@ -13,12 +13,13 @@
 - Provides hierarchical confusion matrix analysis
 """
 
-from typing import Optional, List
-from stickler.structured_object_evaluator.models.structured_model import StructuredModel
-from stickler.structured_object_evaluator.models.comparable_field import ComparableField
+from typing import List, Optional
+
 from stickler.comparators.exact import ExactComparator
-from stickler.comparators.numeric import NumericComparator
 from stickler.comparators.levenshtein import LevenshteinComparator
+from stickler.comparators.numeric import NumericComparator
+from stickler.structured_object_evaluator.models.comparable_field import ComparableField
+from stickler.structured_object_evaluator.models.structured_model import StructuredModel
 
 
 # Define nested data models
@@ -211,7 +212,7 @@ def demonstrate_deprecation_warning():
         warnings.simplefilter("always")
 
         # This will trigger a deprecation warning
-        field = ComparableField(aggregate=True, comparator=ExactComparator())
+        ComparableField(aggregate=True, comparator=ExactComparator())
 
         if w:
             print(f"   Warning: {w[0].message}")

examples/scripts/bulk_evaluation_demo.py

@@ -8,16 +8,17 @@
     python bulk_evaluation_demo.py
 """
 
-from typing import List
-import time
 import json
-from stickler.structured_object_evaluator.models.structured_model import StructuredModel
-from stickler.structured_object_evaluator.models.comparable_field import ComparableField
+import random
+import time
+from typing import List
+
 from stickler.comparators.levenshtein import LevenshteinComparator
 from stickler.structured_object_evaluator.bulk_structured_model_evaluator import (
     BulkStructuredModelEvaluator,
 )
-import random
+from stickler.structured_object_evaluator.models.comparable_field import ComparableField
+from stickler.structured_object_evaluator.models.structured_model import StructuredModel
 
 
 # Define a simple document model for demonstration
@@ -248,7 +249,7 @@ def demo_evaluation_with_output():
         evaluator.update(gt_doc, pred_doc, doc_id)
 
     # Get results and save metrics
-    result = evaluator.compute()
+    evaluator.compute()
     evaluator.save_metrics(metrics_file)
 
     print("\n💾 Output Files Created:")
@@ -340,7 +341,7 @@ def main():
     print("=" * 60)
 
     # Demo 1: Basic bulk evaluation
-    evaluator = demo_basic_bulk_evaluation()
+    demo_basic_bulk_evaluation()
 
     # Demo 2: Batch processing
     demo_batch_processing()