Python clean-code lint plugin and recommended Ruff/Pylint config.
Project description
Clean Code Tools
This repository contains clean-code lint packages, a local MCP server for pattern lookup, and the production clean-code pattern corpus.
Start with docs/README.md for the documentation index.
For vector database ingestion, use data/clean-code-patterns.jsonl. It contains
264 records with aliases, problem statements, use/avoid guidance, good and bad
examples, lintability, and embedding/display text. The expected record shape is
documented in data/vector-record.schema.json.
Suggested vector metadata fields:
idtopiclanguagetitledescriptionlint_candidates
Local MCP
This repo includes a uv-backed FastMCP server in src/python/mcp_server for local
clean-code pattern search.
uv sync
bun run weaviate:dev:start
bun run semantic:ingest -- --reset
bun run mcp:http
Useful checks:
bun run check:fastmcp
bun run check:retrieval-evals
bun run check
The agent-facing tools are documented in docs/fastmcp-local-server.md.
Static Triggers to Semantic Review
Use deterministic lint output as the first pass, then hand selected maintainability tripwires to an agent or MCP-backed review:
bun run clean-code:candidates -- \
--pylint-command "uv run --group lint pylint src/python/mcp_server --output-format=json" \
--ruff-command "uv run --group lint ruff check src/python/mcp_server --output-format=json"
The workflow and clean-code-review-candidates/v1 schema are documented in
docs/static-trigger-semantic-review.md.
Packages
The ESLint plugin/config is distributed through npm, and the Python Pylint
plugin/config is distributed through PyPI. Packaging checks are documented in
docs/publishing.md and run through:
bun run check:packages
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
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 clean_code_tools_python-1.0.5.tar.gz.
File metadata
- Download URL: clean_code_tools_python-1.0.5.tar.gz
- Upload date:
- Size: 7.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a3b28e10a4e20a37e893a40334977542833bb780ea579b0c0aa1b1593f6bf67
|
|
| MD5 |
9a37fa4aa6936b7387ebd5f45dfa654e
|
|
| BLAKE2b-256 |
50c0cebaedf83abf1a845b9eeba13045f1d47d039f0287ad0f88a8c5205c9980
|
File details
Details for the file clean_code_tools_python-1.0.5-py3-none-any.whl.
File metadata
- Download URL: clean_code_tools_python-1.0.5-py3-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
daba07fe3c30f082e77578bf8c2e9921c1a16cb886707ff9cd6b6a391a868d7e
|
|
| MD5 |
b80ccd67335292ff8519582a2acade8d
|
|
| BLAKE2b-256 |
159b5bf0cda95b30f23d6d96552acd3fbce4c90f7dfa85006b782fd41abdc07e
|