readability-cli 0.4.0__py3-none-any.whl

readability_cli-0.4.0.dist-info/METADATA

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: readability-cli
+Version: 0.4.0
+Summary: A CLI to lint, format, and type-check code with Google-style defaults, and pull Google style guides in markdown format.
+Project-URL: Homepage, https://github.com/owahltinez/readability
+Project-URL: Repository, https://github.com/owahltinez/readability
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: beautifulsoup4>=4.14.3
+Requires-Dist: click>=8.3.1
+Requires-Dist: markdownify>=1.2.2
+Requires-Dist: requests>=2.33.0
+Description-Content-Type: text/markdown
+
+# Readability
+
+A CLI tool that keeps code aligned with Google style conventions. It runs the
+right linters, formatters, and type checkers for your project with sensible
+defaults, and serves the official Google style guides in Markdown format. This
+is ideal for AI agents or developers who want consistent code quality checks
+and quick access to style conventions without browsing HTML pages.
+
+## Features
+
+- **Linting & Formatting**: A `check` command that automatically detects and
+  runs relevant tools (Ruff, Pyrefly, Biome, Prettier, gofmt) for your project.
+- **Sensible Defaults**: Bundled Google-style configurations for Ruff and
+  Pyrefly are used automatically when a project does not define its own.
+- **Style Guides**: A `guide` command that fetches the latest Google style
+  guides (Python, Shell, C++, Java, JS/TS, Go, etc.) converted to Markdown.
+- **Offline Mode**: Local caching of style guides for fast, offline access,
+  kept fresh with a single `sync` command.
+
+## Quick Start
+
+You can run the tool directly without installing it using `uvx`:
+
+```bash
+# Check and fix formatting for the current directory
+uvx --from git+https://github.com/owahltinez/readability.git readability check . --fix
+
+# Get the Python style guide
+uvx --from git+https://github.com/owahltinez/readability.git readability guide python
+```
+
+## Installation
+
+Install it as a global tool with `uv`:
+
+```bash
+# Install the readability tool
+uv tool install git+https://github.com/owahltinez/readability.git
+
+# Use it anywhere
+readability check .
+readability guide python
+```
+
+### For Development
+
+This project uses `uv` for dependency management:
+
+```bash
+# Clone the repository
+git clone https://github.com/owahltinez/readability.git
+cd readability
+
+# Install dependencies and create a virtual environment
+uv sync
+
+# (Optional) Populate the local cache for offline use
+uv run readability sync
+```
+
+## Checking and Formatting
+
+The `check` command identifies and runs relevant linting and formatting tools
+based on file extensions and the presence of configuration files (triggers) in
+your project root:
+
+```bash
+# Run checks on the current directory
+readability check .
+
+# Check specific files or directories
+readability check src/ tests/ main.py
+
+# Automatically fix and format files
+readability check . --fix
+```
+
+### Supported Tools
+
+| Tool | Supported Extensions | Trigger Files |
+|------|----------------------|---------------|
+| **Ruff** | `.py` | `pyproject.toml`, `ruff.toml`, `.ruff.toml` |
+| **Pyrefly** | `.py` | `pyproject.toml`, `pyrefly.toml` |
+| **Biome** | `.js`, `.ts`, `.jsx`, `.tsx`, `.json`, `.jsonc`, `.css`, `.html` | `biome.json`, `biome.jsonc` |
+| **Prettier** | `.js`, `.ts`, `.jsx`, `.tsx`, `.json`, `.css`, `.scss`, `.html`, `.md`, `.yml`, `.yaml` | `.prettierrc*`, `prettier.config.*` |
+| **gofmt** | `.go` | `go.mod` |
+
+The command will only run a tool if its trigger file exists in the current
+working directory and the tool is available in your `PATH`. For `biome` and
+`prettier`, it attempts to run them via `npx`.
+
+### Default Configurations
+
+For Ruff and Pyrefly, bundled defaults based on the
+[Google Python style guide](https://google.github.io/styleguide/pyguide.html)
+(80-column lines, Google docstring convention, import ordering, full type
+checking) are applied when the project does not define its own configuration.
+To override them, add a `[tool.ruff]` or `[tool.pyrefly]` section to your
+`pyproject.toml` (or a dedicated `ruff.toml` / `pyrefly.toml`) — any
+project-level configuration takes full precedence over the bundled defaults.
+
+## Style Guides
+
+The `guide` command prints a Google style guide as Markdown, using the local
+cache when available:
+
+```bash
+# Get the Python style guide (uses local cache if available)
+readability guide python
+
+# Force fetching the latest version from the web
+readability guide python --remote
+
+# Save a style guide to a file
+readability guide cpp --output cpp-style.md
+
+# Synchronize all supported style guides to the local cache
+readability sync
+```
+
+### Supported Languages
+
+Use `readability languages` to see a full list of supported languages and
+their aliases. This command also indicates which guides are currently
+available in the local cache with a `[cached]` label:
+
+```bash
+$ readability languages
+Supported languages and their aliases:
+  - r [cached]
+  - c++, cpp [cached]
+  - c#, csharp [cached]
+  - docguide, markdown [cached]
+  - go [cached]
+  - css, html [cached]
+  - java [cached]
+  - javascript, js [cached]
+  - json [cached]
+  - objc, objective-c [cached]
+  - python [cached]
+  - shell [cached]
+  - ts, typescript [cached]
+  - vim [cached]
+```
+
+### Offline Mode
+
+The tool stores local copies of the style guides in the `guides/` directory
+and the `guide` command uses these local files when they exist. The bundled
+copies are automatically synchronized weekly from the official
+[Google Style Guides](https://google.github.io/styleguide/) repository via
+GitHub Actions, and you can refresh your local cache at any time with the
+`sync` command.
+
+You can override the default `guides/` directory by setting the
+`READABILITY_CACHE` environment variable. This is useful if you want to store
+the guides in a specific location or share them across different
+installations:
+
+```bash
+export READABILITY_CACHE=/path/to/my/guides
+readability guide python
+```
+
+## Development
+
+Run tests with `pytest`:
+
+```bash
+uv run pytest
+```
+
+Check code style with `ruff`:
+
+```bash
+uv run ruff check .
+uv run ruff format .
+```

readability_cli-0.4.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+readability.py,sha256=hhVPmknYJC2VqdOCEdFTbHImnb5Yhapo5eGIkn9Sw1o,23725
+configs/pyrefly.toml,sha256=uzJ-ZNtnFd27ho_yjzsaaHJRMW8o1OGT1Vm9xQaPfFE,549
+configs/ruff.toml,sha256=c8TXRMyLgNbX1OIUzhj2WjCwlaA2m4zapTyQYzqzeVY,724
+guides/Rguide.md,sha256=Dpilm781ocQVVpqo8BsKgJ4Q98mI8V_Ph8XUjA5XVHk,2982
+guides/cppguide.md,sha256=6aY-x5wPxJaGgSvJ7_IqnRuTRuTYFpgolwLzsE61CLA,212043
+guides/csharp-style.md,sha256=Gj45PQOhmjzEgLNbJQ2XU1-AiXStjM2aSV1Px1Agfjw,20114
+guides/docguide-style.md,sha256=z27xe0pMckIKYWIaGW6WSADhZsmhMwTIq5iedgSy7pU,25897
+guides/go-guide.md,sha256=8SBRwiBFlTw2iKhfnrqU989htqdpdiZxzb8cpNKzqhs,19740
+guides/htmlcssguide.md,sha256=V4oo7KpmxjVvM7LybPh6bZhAC_4SwuWH8LQmdccl8uY,23741
+guides/javaguide.md,sha256=4W1shlXj5GDPg83jSE6K1l59tzYKyp4feCneYZzKUUE,42340
+guides/jsguide.md,sha256=GchGywHKtYxruG0bsz3sfb8f3K0NAjNikQWwgTO0s7o,120204
+guides/jsoncstyleguide.md,sha256=oe2KBfAamHu3nB5xWLf6Z3zzy8KfUFZEzPW9vbztjIY,36860
+guides/objcguide.md,sha256=1SPaqAJvOxY27GQBetyrPfMCfbdlU2DuwBK-IutL5JU,72787
+guides/pyguide.md,sha256=C9F-rZ5tYLRVAjme9DQaGxuN5FlcC1jpwnLrc_SCfvQ,115828
+guides/shellguide.md,sha256=rw6ZVytl2cZNoANafZ-8PDLYHcconKQTQNEHhyakZL8,40209
+guides/tsguide.md,sha256=jrwcbwAaz3VrSpztyv06EfMSVP5D4wUou84QscrW5WA,106318
+guides/vimscriptguide.md,sha256=asTCEMFryWc1dXN3b8BTix_Y-CX03X4oXkhQXqAa1SU,8156
+readability_cli-0.4.0.dist-info/METADATA,sha256=uOsybXOb6FuGTT9B-moPpvYxHJiHXQtC54qpxQZWPIE,6029
+readability_cli-0.4.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+readability_cli-0.4.0.dist-info/entry_points.txt,sha256=i2flgczUe8ztECWI30D-_oBHmZwqXXkyVGBiSRO1ayI,49
+readability_cli-0.4.0.dist-info/licenses/LICENSE,sha256=LHFhXRfOqppxH3pCE8mWWr3RP_FWivgx5qgh927IFwM,1067
+readability_cli-0.4.0.dist-info/RECORD,,

readability_cli-0.4.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

readability_cli-0.4.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+readability = readability:main

readability_cli-0.4.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 owahltinez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.