Skip to content

Sort README entries alphabetically #2728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

mehmetdogandev
Copy link

@mehmetdogandev mehmetdogandev commented Jul 4, 2025

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

@mehmetdogandev
Copy link
Author

Thanks @poteakshay241

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy