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"]}

[[tool.rattle.overrides]]
path = "legacy"
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.4.2.tar.gz (285.2 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.4.2-py3-none-any.whl (205.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rattle_lint-2.4.2.tar.gz
  • Upload date:
  • Size: 285.2 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.4.2.tar.gz
Algorithm Hash digest
SHA256 e99688c0e46c75c6216642900ec2803178aada98ec28327fd50185d3058c1d23
MD5 549b99b53993229c249a59ce66d1f0cc
BLAKE2b-256 8ddf27509b71a960e575e8526edfc5159339c94066261aa287985dd143a2007e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rattle_lint-2.4.2-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

Hashes for rattle_lint-2.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8ff1c7a5496bc0403b94556629d7477fbf19d6181c889a1b0cb619740c349fa2
MD5 62ef5ad33ecd52949d9002d9c1f4f41c
BLAKE2b-256 e2c934fe1017b021804acb87a17691ade5f612bb70f1acc3f9355812c1fb9d78

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