A framework for custom Python linters with auto-fixes and hierarchical configuration
Project description
Rattle
Rattle is a Python linting framework built on LibCST with support for autofixes, custom in-repo lint rules, and hierarchical configuration.
Rattle is a fork of Fixit.
Features
- 48 built-in lint rules
- Autofix support when a rule can safely rewrite code
- Local custom rules that can live inside your repository
- Hierarchical
pyproject.tomlconfiguration - Pre-commit integration for CI and local workflows
- LSP support
Install
Install the CLI from PyPI:
pip install rattle-lint
Install editor/LSP support too:
pip install "rattle-lint[lsp]"
Agent Skill
The official AI agent skill can be installed from this repo.
npx skills add https://github.com/zigai/rattle/tree/main/src/rattle/.agents/skills/create-rattle-lint-rules
or
uvx library-skills
Basic Usage
Rattle runs with no enabled rules until a project enables them in
pyproject.toml:
[tool.rattle]
enable = ["fixit"]
rattle lint
Apply available autofixes:
rattle fix
Explain rule metadata, examples, and settings:
rattle explain use-f-string
rattle explain --json use-f-string
Example Configuration
[tool.rattle]
root = true
enable = ["fixit"]
python-version = "3.10"
disable = [
"no-static-if-condition",
"use-rattle-ignore-comment",
]
per-file-disable = {"tests/generated.py" = ["no-named-tuple"]}
[[tool.rattle.overrides]]
path = "legacy"
enable = ["fixit-extra"]
[[tool.rattle.overrides]]
path = "tests"
enable = ["no-named-tuple"]
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rattle_lint-2.4.1.tar.gz.
File metadata
- Download URL: rattle_lint-2.4.1.tar.gz
- Upload date:
- Size: 285.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
90b2a91263e0825bd67aaf2eba3555f3dacd881124fbac176ad8af6ac6d8af1c
|
|
| MD5 |
0088cc9ae101c128668be844f4206711
|
|
| BLAKE2b-256 |
2fbf220a532334dee61bd138c578c083dadb2eac6c261777fb08f847764cc114
|
File details
Details for the file rattle_lint-2.4.1-py3-none-any.whl.
File metadata
- Download URL: rattle_lint-2.4.1-py3-none-any.whl
- Upload date:
- Size: 205.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dece185e54ba45da084eafb9c886b349bb684459d14ea6d0a9c84b34197b1c9e
|
|
| MD5 |
349a230dd5d5fe393ef5b15d98dee8a3
|
|
| BLAKE2b-256 |
b8079f06f84b48213111c3b92796e3fac759ada666378e92cd9952b9408be7fc
|