AGENTS.md

1# AGENTS.md
2 
3## Repository Overview
4 
5An opinionated list of Python frameworks, libraries, tools, and resources. Published at [awesome-python.com](https://awesome-python.com/).
6 
7## Entry Guidelines
8 
9**Refer to [CONTRIBUTING.md](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.
10 
11## Structure
12 
13- **README.md**: Source of truth for catalog entries and README sponsor placements. Hierarchical categories with alphabetically ordered entries.
14- **CONTRIBUTING.md**: Submission guidelines and review criteria.
15- **SPONSORSHIP.md**: Sponsor tiers, placement rules, and the editorial-independence policy. `website/templates/sponsorship.html` separately defines which sponsorship content appears on the published website page.
16- **website/**: Static site generator that builds awesome-python.com from README.md.
17  - `build.py`: Parses README.md and renders HTML via Jinja2 templates.
18  - `fetch_github_stars.py`: Fetches star counts into `website/data/`.
19  - `readme_parser.py`: Markdown-to-structured-data parser.
20  - `templates/`, `static/`: Jinja2 templates and CSS/JS assets.
21  - `tests/`: Pytest tests for the build pipeline.
22- **Makefile**: `make install`, `make build`, `make preview`, `make test`, `make lint`, `make format`, `make typecheck`, `make fetch_github_stars`.
23- **pyproject.toml**: Uses `uv` for dependency management. Python >=3.13.
24 
25## Key Rules
26 
27- Alphabetical ordering within categories is mandatory.
28- Quality over quantity. Only "awesome" projects.
29- One project per PR.
30- One entry per commit when adding or deleting entries. Format, wording, or categorization changes across multiple entries may be bundled in a single commit.
31- README.md is the source of truth for catalog entries and README sponsor placements; treat `SPONSORSHIP.md` and `website/templates/sponsorship.html` as separate sponsorship content surfaces.
32