Files
Vinta Chen 4fb6c405bd docs: reference SPONSORSHIP.md in Structure section
Note the editorial-independence policy so sponsor placements are never conflated with curated listings.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-22 01:02:51 +08:00

1.7 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 acceptance criteria, 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 with alphabetically ordered entries.
  • 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 into website/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 uv for dependency management. Python >=3.13.

Key Rules

  • Alphabetical ordering within categories is mandatory.
  • Quality over quantity. Only "awesome" projects.
  • One project per PR.
  • One entry per commit when adding or deleting entries. Format, wording, or categorization changes across multiple entries may be bundled in a single commit.
  • README.md is the single source of content truth.