mirror of https://github.com/vinta/awesome-python.git synced 2026-03-23 13:56:43 +08:00

Files

Vinta Chen 1b5a0c2a3c docs(claude): expand project structure and entry format docs

Documents the website/ build pipeline, Makefile targets, pyproject.toml
tooling, and tightens the entry format example and key rules.

Co-Authored-By: Claude <noreply@anthropic.com>

2026-03-22 16:41:42 +08:00

1.4 KiB

Raw Blame History

CLAUDE.md

Repository Overview

A curated list of awesome Python frameworks, libraries, software and resources. Published at awesome-python.com.

PR Review Guidelines

Refer to CONTRIBUTING.md for acceptance criteria, quality requirements, rejection rules, and entry format.

Structure

README.md: Source of truth. Hierarchical categories with alphabetically ordered entries.
CONTRIBUTING.md: Submission guidelines and review criteria.
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.

Entry Format

- [pypi-name](https://github.com/owner/repo) - Description ending with period.

Use PyPI package name as display name. Use GitHub URLs when available.

Key Rules

Alphabetical ordering within categories is mandatory.
Quality over quantity. Only "awesome" projects.
One project per PR.
README.md is the single source of content truth.

1.4 KiB Raw Blame History