ruff-config/README.md

@lilith/ruff-config

Shared Ruff linting and formatting configuration for Lilith Python projects.

Installation

pip install lilith-ruff-config

Usage

Option 1: Copy config to project (Recommended)

# Copy the base config to your project
python -c "from lilith_ruff_config import get_config_path; print(open(get_config_path()).read())" > ruff.base.toml

Then in your pyproject.toml:

[tool.ruff]
extend = "./ruff.base.toml"

Option 2: Dynamic path resolution

from lilith_ruff_config import get_config_path

# Returns the installed config path (works across Python versions)
config_path = get_config_path()

Option 3: Direct extend (version-specific)

# Note: Replace python3.XX with your Python version
[tool.ruff]
extend = ".venv/lib/python3.XX/site-packages/lilith_ruff_config/ruff.toml"