Skip to main content

A framework for custom Python linters with auto-fixes and hierarchical configuration

Project description

Rattle

Tests Documentation Status PyPI version Supported versions Downloads License: MIT

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.toml configuration
  • 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"]}

# Apply extra rules only under the src/ directory.
[[tool.rattle.overrides]]
path = "src"
enable = ["fixit-extra"]

[[tool.rattle.overrides]]
path = "tests"
enable = ["no-named-tuple"]

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rattle_lint-2.5.2.tar.gz (293.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rattle_lint-2.5.2-py3-none-any.whl (213.4 kB view details)

Uploaded Python 3

File details

Details for the file rattle_lint-2.5.2.tar.gz.

File metadata

  • Download URL: rattle_lint-2.5.2.tar.gz
  • Upload date:
  • Size: 293.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for rattle_lint-2.5.2.tar.gz
Algorithm Hash digest
SHA256 6478a62fed55ace2513c848cb25e5b9f26911956cfcb217d7bec3486466acd91
MD5 ef6f55715aaaeb1f2a9c85992fc7e3c9
BLAKE2b-256 143077af8fd1f66c6ede6227bc83129c424fab1becac65a42fd18323757c65e0

See more details on using hashes here.

File details

Details for the file rattle_lint-2.5.2-py3-none-any.whl.

File metadata

  • Download URL: rattle_lint-2.5.2-py3-none-any.whl
  • Upload date:
  • Size: 213.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for rattle_lint-2.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 13cfd3ae18da306795e6d4dfbf033ef9a1db433b7c07a6115e9ba9b481fd5b0e
MD5 214e0b1b5129ec6324650d8bd37bd046
BLAKE2b-256 230150de68c077a272964f9fc526c33855c0d67c22531509c21c79be1e3cba54

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page