[PR #2728] Sort README entries alphabetically #2041

Open
opened 2025-11-06 13:28:19 -06:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/vinta/awesome-python/pull/2728
Author: @mehmetdogandev
Created: 7/4/2025
Status: 🔄 Open

Base: masterHead: main


📝 Commits (5)

  • abd84d0 update short.py file
  • 7242413 new sort.py run so update README.md
  • 5d57c5a new update: add new feature to awesome-python project
  • 9c070e1 new update to awesome-python html and pdf files
  • 375095f new update add new file awesome-python-premium.pdf

📊 Changes

10 files changed (+7678 additions, -90 deletions)

View changed files

📝 README.md (+22 -22)
awesome-python-dashboard.html (+302 -0)
awesome-python-modern.html (+4718 -0)
awesome-python-premium.pdf (+0 -0)
awesome-python.html (+1264 -0)
awesome-python.pdf (+0 -0)
docs/css/pdf.css (+71 -0)
📝 mkdocs.yml (+47 -2)
📝 requirements.txt (+6 -2)
📝 sort.py (+1248 -64)

📄 Description

Summary

This PR adds an automated sorting script that organizes README entries alphabetically, making it easier for users to find Python libraries and for maintainers to manage the list.

Motivation

The current README has libraries scattered throughout sections without alphabetical order, making it difficult for users to quickly locate specific tools. This script automates the sorting process and maintains consistency.

Key Features

  • 🔤 Alphabetical Sorting: Automatically sorts all library entries within their categories
  • 📄 PDF Generation: Creates professional PDF versions for offline reading
  • 🏗️ Structure Preservation: Maintains existing README structure and formatting
  • 🔧 Cross-platform: Works on Windows, macOS, and Linux
  • 📱 Multiple Output Formats: Supports ReportLab PDF and HTML-to-PDF conversion

Files Added/Modified

  • sort.py - Main sorting script with comprehensive documentation
  • requirements.txt - Added dependencies for PDF generation
  • mkdocs.yml - Updated configuration for PDF export capability
  • README.md - Sorted all entries alphabetically while preserving structure
  • docs/css/pdf.css - Styling for PDF generation

Technical Implementation

  • Dual Sorting Approach: Line-based and section-based sorting algorithms
  • Indentation-Aware: Preserves nested list structures
  • Link-Safe Processing: Maintains all markdown links and descriptions
  • Error Handling: Comprehensive error checking and user feedback

Usage Examples

# Basic README sorting
python sort.py

# Generate professional PDF
python sort.py --pdf

# Create HTML for browser-based PDF conversion
python sort.py --html

---

<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
## 📋 Pull Request Information **Original PR:** https://github.com/vinta/awesome-python/pull/2728 **Author:** [@mehmetdogandev](https://github.com/mehmetdogandev) **Created:** 7/4/2025 **Status:** 🔄 Open **Base:** `master` ← **Head:** `main` --- ### 📝 Commits (5) - [`abd84d0`](https://github.com/vinta/awesome-python/commit/abd84d0e20ac27e456e31c69d153fdee6fbb39d3) update short.py file - [`7242413`](https://github.com/vinta/awesome-python/commit/724241397a17a5bf811ed11de3f733dae8963c7a) new sort.py run so update README.md - [`5d57c5a`](https://github.com/vinta/awesome-python/commit/5d57c5ad0bb4b6afe1a1d64c2b2ad9fe92eaf1fe) new update: add new feature to awesome-python project - [`9c070e1`](https://github.com/vinta/awesome-python/commit/9c070e169884595a6a5f36cd7a85381e3397a74c) new update to awesome-python html and pdf files - [`375095f`](https://github.com/vinta/awesome-python/commit/375095f4b1c27429916b60d7ab296dfd5d237828) new update add new file awesome-python-premium.pdf ### 📊 Changes **10 files changed** (+7678 additions, -90 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+22 -22) ➕ `awesome-python-dashboard.html` (+302 -0) ➕ `awesome-python-modern.html` (+4718 -0) ➕ `awesome-python-premium.pdf` (+0 -0) ➕ `awesome-python.html` (+1264 -0) ➕ `awesome-python.pdf` (+0 -0) ➕ `docs/css/pdf.css` (+71 -0) 📝 `mkdocs.yml` (+47 -2) 📝 `requirements.txt` (+6 -2) 📝 `sort.py` (+1248 -64) </details> ### 📄 Description ## Summary This PR adds an automated sorting script that organizes README entries alphabetically, making it easier for users to find Python libraries and for maintainers to manage the list. ## Motivation The current README has libraries scattered throughout sections without alphabetical order, making it difficult for users to quickly locate specific tools. This script automates the sorting process and maintains consistency. ## Key Features - 🔤 **Alphabetical Sorting**: Automatically sorts all library entries within their categories - 📄 **PDF Generation**: Creates professional PDF versions for offline reading - 🏗️ **Structure Preservation**: Maintains existing README structure and formatting - 🔧 **Cross-platform**: Works on Windows, macOS, and Linux - 📱 **Multiple Output Formats**: Supports ReportLab PDF and HTML-to-PDF conversion ## Files Added/Modified - `sort.py` - Main sorting script with comprehensive documentation - `requirements.txt` - Added dependencies for PDF generation - `mkdocs.yml` - Updated configuration for PDF export capability - `README.md` - Sorted all entries alphabetically while preserving structure - `docs/css/pdf.css` - Styling for PDF generation ## Technical Implementation - **Dual Sorting Approach**: Line-based and section-based sorting algorithms - **Indentation-Aware**: Preserves nested list structures - **Link-Safe Processing**: Maintains all markdown links and descriptions - **Error Handling**: Comprehensive error checking and user feedback ## Usage Examples ```bash # Basic README sorting python sort.py # Generate professional PDF python sort.py --pdf # Create HTML for browser-based PDF conversion python sort.py --html --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2025-11-06 13:28:19 -06:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/awesome-python#2041