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.3.tar.gz (294.3 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.3-py3-none-any.whl (213.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rattle_lint-2.5.3.tar.gz
  • Upload date:
  • Size: 294.3 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.3.tar.gz
Algorithm Hash digest
SHA256 a9badd9c33ab076c9749da8e2094b688b5d43fb25d51ce596489219c8c9812e4
MD5 80145d55e923c4bfcf3d2809a81cc268
BLAKE2b-256 990536a2ed4de17d42bd21aae25c90658f87f07c0adc7a0cff7ed4f4964f9f0d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rattle_lint-2.5.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 40fe5aa20cba8118920a849b8bd599b910baf0a70b1e4ec8788f0a4a3b4e8fc2
MD5 b5eb8069cac7032d9506440e03a7b7b4
BLAKE2b-256 7078dd23dcef9bc3c41bdff363fd4f49cad3c59ec857a1681a0e4f893749d5a8

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