Mirrors_Framework/awesome-python
1
0
Fork 0
mirror of https://github.com/vinta/awesome-python.git synced 2026-05-31 07:08:42 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs(claude): expand project structure and entry format docs

Browse Source 
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>
This commit is contained in:
Vinta Chen
2026-03-22 16:41:42 +08:00
parent 8fbe0e0394
commit 1b5a0c2a3c
1 changed files with 23 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+23 -18
View File
@@ -2,31 +2,36 @@
## Repository Overview ## Repository Overview
This is the awesome-python repository - a curated list of Python frameworks, libraries, software and resources. The repository serves as a comprehensive directory about Python ecosystem. A curated list of awesome Python frameworks, libraries, software and resources. Published at [awesome-python.com](https://awesome-python.com/).
## PR Review Guidelines ## PR Review Guidelines
**For all PR review tasks, refer to [CONTRIBUTING.md](CONTRIBUTING.md)** which contains: **Refer to [CONTRIBUTING.md](CONTRIBUTING.md)** for acceptance criteria, quality requirements, rejection rules, and entry format.
- Acceptance criteria (Industry Standard, Rising Star, Hidden Gem) ## Structure
- Quality requirements
- Automatic rejection criteria
- Entry format reference
- PR description template
## Architecture & 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.
The repository follows a single-file architecture: ## Entry Format
- **README.md**: All content in hierarchical structure (categories, subcategories, entries) ```markdown
- **CONTRIBUTING.md**: Submission guidelines and review criteria - [pypi-name](https://github.com/owner/repo) - Description ending with period.
- **sort.py**: Script to enforce alphabetical ordering ```
Entry format: `* [project-name](url) - Concise description ending with period.` Use PyPI package name as display name. Use GitHub URLs when available.
## Key Considerations ## Key Rules
- This is a curated list, not a code project - Alphabetical ordering within categories is mandatory.
- Quality over quantity - only "awesome" projects - Quality over quantity. Only "awesome" projects.
- Alphabetical ordering within categories is mandatory - One project per PR.
- README.md is the source of truth for all content - README.md is the single source of content truth.