fix: ruff lint fixes, add ruff CI step, CONTRIBUTING.md, remove BOM from config files

Author: Revenue Holdings

.github/workflows/ci.yml

@@ -25,6 +25,9 @@ jobs:
         run: |
           pip install -e ".[dev]"
 
+      - name: Lint with ruff
+        run: pip install ruff && ruff check src/ --target-version py310
       - name: Run tests
         run: |
           python -m pytest tests/ -v --cov=src --cov-report=term-missing
+

.github/workflows/publish.yml

@@ -51,3 +51,4 @@ jobs:
           TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
         run: |
           twine upload --repository testpypi dist/* --verbose
+

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+Thanks for your interest in contributing!
+
+## Development Setup
+
+1. Fork and clone the repo
+2. Create a virtual environment: python -m venv .venv && source .venv/bin/activate
+3. Install dev dependencies: pip install -e ".[dev]"
+4. Run tests: pytest tests/ -v
+5. Lint: uff check src/
+
+## Pull Requests
+
+- Fork the repo and create a feature branch
+- Add tests for any new functionality
+- Ensure all existing tests pass
+- Run uff check src/ --fix before committing
+- Keep PRs focused on a single change
+
+## Reporting Issues
+
+- Use GitHub Issues
+- Include Python version, OS, and steps to reproduce
+- Include relevant error output
+
+## Code Style
+
+- Python 3.10+
+- Type hints where practical
+- Follow ruff defaults (Black-compatible formatting)
+
+## License
+
+By contributing, you agree your work will be licensed under the same license as this project.

pyproject.toml

@@ -35,3 +35,14 @@ json2sql = "json2sql.cli:app"
 
 [tool.setuptools.packages.find]
 where = ["src"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM"]
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["*"]

src/json2sql/cli.py

@@ -1,10 +1,8 @@
 """CLI interface for json2sql using Typer."""
 
 import sys
-from pathlib import Path
-from typing import Optional
-
 import typer
+from pathlib import Path
 
 try:
     from revenueholdings_license import require_license
@@ -23,12 +21,12 @@
 
 @app.command()
 def convert(
-    input_file: Optional[Path] = typer.Argument(
+    input_file: Path | None = typer.Argument(  # noqa: B008
         None,
         help="Path to JSON file. Reads from stdin if not provided.",
         exists=True,
     ),
-    dialect: Dialect = typer.Option(
+    dialect: Dialect = typer.Option(  # noqa: B008
         Dialect.POSTGRES,
         "--dialect",
         "-d",
@@ -40,7 +38,7 @@ def convert(
         "-t",
         help="Table name for INSERT statements.",
     ),
-    output: Optional[Path] = typer.Option(
+    output: Path | None = typer.Option(  # noqa: B008
         None,
         "--output",
         "-o",
@@ -79,7 +77,7 @@ def convert(
             result = converter.convert(json_text, table_name=table)
     except Exception as e:
         typer.echo(f"Error converting JSON: {e}", err=True)
-        raise typer.Exit(code=1)
+        raise typer.Exit(code=1) from e
 
     # Write output
     if output:

src/json2sql/converter.py

@@ -1,14 +1,12 @@
 """Core JSON-to-SQL conversion logic."""
 
 import json
-from typing import Any
 
 from .dialects import (
     Dialect,
     create_table_sql,
     format_value,
     insert_sql,
-    quote_identifier,
     sql_type_for,
 )
 
@@ -183,7 +181,7 @@ def _flatten_object(
         row: list[str],
     ) -> None:
         """Flatten a nested object into parent row with prefixed keys."""
-        for sub_key, sub_value in nested.items():
+        for _sub_key, sub_value in nested.items():
             row.append(format_value(sub_value, self.dialect))
 
     def _process_flatten(self, objects: list, table_name: str) -> None:

src/json2sql/dialects.py

@@ -41,7 +41,7 @@ def sql_type_for(value: Any, dialect: Dialect) -> str:
     if value is None:
         return _TYPE_MAP[dialect].get(str, "TEXT")
     py_type = type(value)
-    if py_type == bool:  # bool must be checked before int (bool is subclass of int)
+    if py_type is bool:  # bool must be checked before int (bool is subclass of int)
         return _TYPE_MAP[dialect][bool]
     return _TYPE_MAP[dialect].get(py_type, "TEXT")