mirror of
https://github.com/vinta/awesome-python.git
synced 2026-05-18 03:33:31 +08:00
Vinta Chen
4e85b22d11
Rename PR Review Guidelines to Entry Guidelines and clarify that CONTRIBUTING.md rules apply to any entry addition or removal, not just PR reviews. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
39 lines
1.7 KiB
Markdown
39 lines
1.7 KiB
Markdown
# CLAUDE.md
|
|
|
|
## Repository Overview
|
|
|
|
An opinionated list of Python frameworks, libraries, tools, and resources. Published at [awesome-python.com](https://awesome-python.com/).
|
|
|
|
## Entry Guidelines
|
|
|
|
**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.
|
|
|
|
## 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
|
|
|
|
```markdown
|
|
- [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.
|