mirror of
https://github.com/vinta/awesome-python.git
synced 2026-10-06 17:05:16 +08:00
Land the shortlist-reform rules approved by the maintainer (rules first; entry sweeps are not authorized yet). - CONTRIBUTING.md: replace the Industry Standard / Rising Star / Hidden Gem lanes with a single admission rule per use case (up to 3 obvious choices + up to 2 challengers, hard max 5), add Displacement, the stdlib rule, and editorial-judgment-as-final evidence guidance; scope test becomes Serves Python Developers; document entry ordering (obvious choices then challengers, each alphabetical). - README.md: add the shortlist promise paragraph pointing rejected contributors to linked awesome-* catalogs and to CONTRIBUTING.md. - CLAUDE.md: sync Key Rules with the new ordering and shortlist cap, and add the prune-sweep one-commit-per-section exception. - docs/adr/0001-shortlist-not-catalog.md: flip status from proposed to accepted. Co-Authored-By: Claude <noreply@anthropic.com>
1.9 KiB
1.9 KiB
CLAUDE.md
Repository Overview
An opinionated list of Python frameworks, libraries, tools, and resources. Published at awesome-python.com.
Entry Guidelines
Refer to CONTRIBUTING.md for admission rules, quality requirements, rejection rules, and entry format. Apply these rules whenever adding or removing an entry, whether reviewing a PR or committing directly.
Structure
- README.md: Source of truth. Hierarchical categories; entries ordered per the Key Rules below.
- CONTRIBUTING.md: Submission guidelines and review criteria.
- SPONSORSHIP.md: Sponsor tiers, placement rules, and the editorial-independence policy. Sponsor content sits in the README header and must never influence which projects get listed.
- website/: Static site generator that builds awesome-python.com from README.md.
build.py: Parses README.md and renders HTML via Jinja2 templates.fetch_github_stars.py: Fetches star counts intowebsite/data/.readme_parser.py: Markdown-to-structured-data parser.templates/,static/: Jinja2 templates and CSS/JS assets.tests/: Pytest tests for the build pipeline.
- Makefile:
make install,make build,make preview,make test,make fetch_github_stars. - pyproject.toml: Uses
uvfor dependency management. Python >=3.13.
Key Rules
- Ordering within a use case: obvious choices first (alphabetically), then challengers (alphabetically). See CONTRIBUTING.md.
- A shortlist, not a catalog: per use case, up to 3 obvious choices plus up to 2 challengers, hard maximum 5.
- One project per PR.
- One entry per commit when adding or deleting entries. Exception: a prune sweep is one commit per section, its body listing each removal with its reason. Format, wording, or categorization changes across multiple entries may be bundled in a single commit.
- README.md is the single source of content truth.