Update: add 4 file(s), modify 5 file(s)

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

@@ -4,6 +4,10 @@
 **/*.egg-info/
 .coverage
 .ash/
+.venv/
 
 .kiro/*
 .kiro/**/*
+
+uv.lock
+

.vscode/settings.json.example

@@ -0,0 +1,19 @@
+{
+  "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+  "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
+}

AGENTS.md

@@ -0,0 +1,16 @@
+# General Guidance for Agentic Coding Assistants
+
+## Documentation
+- When writing documentation, always try to say more with less.
+- Documentation should be minimal, and only say what needs to be said to communicate how to work with and extend the system.
+
+## MKDocs Documentation Project
+- An MKDocs documentation project exists at [docs/](./docs/). More information can be found in the [docs/README.md](./docs/README.md) and [docs/AGENTS.md](./docs/AGENTS.md) files.
+
+## Testing
+- Test documentation and guidelines can be found in [tests/README.md](./tests/README.md).
+
+## README.md 
+- In addition to MKDocs, The project strives to maintain developer documentation distributed in README.md files throughout the codebase. This documentation exists to help human and AI coding assistants when working with the codebase.
+- When creating directories or working in a directory that does not have a README.md create a README.md file and document the final state of the code and logic that's in the directory. Do this in language that an AI coding assistant trying to understand the implementation and codebas would understand.
+- When working in a directory, always look for a README.md and/or AGENTS.md file for important context about the directory/code contained within.

Makefile

@@ -1,7 +1,13 @@
 # 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 .
+	pip install -e ".[all]"
 
 install-dev:
 	pip install -e ".[dev]"
@@ -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
+# Strict lint check for CI/CD (currently disabled, see lint-cicd_x for reference)
+lint-cicd_x:
+	@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)"

README.md

@@ -654,3 +654,8 @@ print(f"Line Items: {result['field_scores']['line_items']:.3f}")  # ~1.0 - match
 ## Examples
 
 Check out the `examples/` directory for more detailed usage examples and notebooks.
+
+# A note for AI assisted coding agents
+- The project uses coding assistant agnostic context files, like README.md and AGENTS.md
+- When working in a directory, always look for a README.md and/or AGENTS.md file for important context about the directory/code contained within.
+- Read this [AGENTS.md](./AGENTS.md) file for more information

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.

pyproject.toml

@@ -27,7 +27,8 @@ dev = [
     "pytest>=7.0.0",
     "pytest-xdist>=3.0.0",
     "coverage>=7.0.0",
-    "beautifulsoup4>=4.14.2"
+    "beautifulsoup4>=4.14.2",
+    "ruff>=0.14.10",
 ]
 
 llm = [

ruff.toml

@@ -0,0 +1,91 @@
+# Let's exclude some whole directories until we are ready to format them individually
+extend-exclude = []
+
+
+
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.9
+target-version = "py39"
+
+[lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = []
+# Note: if you're using Ruff to organize imports in VS Code and also expect to run Ruff from the command line, you'll want to enable Ruff's isort rules by adding "I" to your extend-select.
+extend-select = ["I"]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[lint.per-file-ignores]
+# Let's ignore some annoying rules in notebooks
+"notebooks/*" = ["F401"]
+# Disable module level import not at top of file for src (needed for path manipulation)
+"src/**/*.py" = ["E402"]
+
+
+[format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"