Render Ruff rule docs in the terminal or open them in a browser
Project description
ruff-explain
ruff-explain looks up Ruff rule documentation by rule ID and renders the docs page directly in your terminal with Rich.
What it does
- Renders Ruff rule docs in the terminal by default.
- Opens the canonical docs page in your browser with
-o/--open. - Resolves rule IDs like
FAST001,F401, andARG001from a bundled rule map. - Keeps the output focused on the actual rule content instead of full site chrome.
Usage
uv run ruff-explain FAST001
uv run ruff-explain F401
uv run ruff-explain ARG001 -o
Run from source
Run it from the repo with uv:
uv run ruff-explain FAST001
Notes
- Default behavior is terminal rendering.
--openskips rendering, opens the docs page immediately, and exits.- Unknown rule IDs return a non-zero exit code and show close matches when available.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ruff_explain-1.0.0.tar.gz
(38.8 kB
view details)
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 ruff_explain-1.0.0.tar.gz.
File metadata
- Download URL: ruff_explain-1.0.0.tar.gz
- Upload date:
- Size: 38.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"NixOS","version":"26.05","id":"yarara","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
95984bf9699b194d2aaaa354ddd6822c9a05feafd5893f4e025b08d4febb1e04
|
|
| MD5 |
c58b2dd6886880cf860de5336bc13c1c
|
|
| BLAKE2b-256 |
6347898a749e1bbc70348dd7950b1fab9cf1a5b71e91b26916499f5cb696069c
|
File details
Details for the file ruff_explain-1.0.0-py3-none-any.whl.
File metadata
- Download URL: ruff_explain-1.0.0-py3-none-any.whl
- Upload date:
- Size: 40.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"NixOS","version":"26.05","id":"yarara","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
96568a0135411b74a40e7469c953f048df4dbdd6090cc3879897b073947b4ef4
|
|
| MD5 |
14d9e27fa94f6b9bce454c86b9968bea
|
|
| BLAKE2b-256 |
bb2704a2ef2eb605d29cfbb83832d24b75bc83492fe973c8e17b607acbf78d6f
|
