mirror of https://github.com/vinta/awesome-python.git synced 2026-05-09 22:53:49 +08:00

Files

T

Vinta Chen e153f10561 docs: add commit granularity rule for entry changes

One entry per commit when adding or deleting, but format or wording changes across entries can be bundled.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-04-22 00:29:24 +08:00

1.6 KiB

Raw Blame History

CLAUDE.md

Repository Overview

An opinionated list of Python frameworks, libraries, tools, 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

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

Use PyPI package name as display name. If not on PyPI, use the GitHub repo name. Use GitHub URLs when available.

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.

1.6 KiB Raw Blame History