### Manual Setup and Deployment for MkDocs Source: https://context7.com/vinta/awesome-python/llms.txt Commands to manually create a symbolic link for the README and deploy the MkDocs site. Assumes the project is cloned and dependencies are installed. ```shell ln -sf $(pwd)/README.md $(pwd)/docs/index.md mkdocs gh-deploy --clean ``` -------------------------------- ### Markdown Content Structure for Categories Source: https://context7.com/vinta/awesome-python/llms.txt Example of how libraries are listed within categories using Markdown. Includes library name, GitHub link, and a brief description. ```markdown # Web Development ## Web Frameworks * [django](https://github.com/django/django) - Full-stack framework with ORM, admin panel * [flask](https://github.com/pallets/flask) - Lightweight microframework * [fastapi](https://github.com/tiangolo/fastapi) - Modern async API framework ## RESTful API * [django-rest-framework](https://github.com/encode/django-rest-framework) - Powerful Django API toolkit * [flask-restful](https://github.com/flask-restful/flask-restful) - REST APIs for Flask * [falcon](https://github.com/falconry/falcon) - High-performance cloud APIs # Data Science & ML ## Machine Learning * [scikit-learn](http://scikit-learn.org/) - General-purpose ML library * [xgboost](https://github.com/dmlc/xgboost) - Gradient boosting library * [pytorch](https://github.com/pytorch/pytorch) - Deep learning framework ## Data Analysis * [pandas](http://pandas.pydata.org/) - Data structures and analysis tools * [numpy](http://www.numpy.org/) - Scientific computing fundamentals * [scipy](https://www.scipy.org/) - Mathematics, science, engineering ## Data Visualization * [matplotlib](https://github.com/matplotlib/matplotlib) - 2D plotting library * [seaborn](https://github.com/mwaskom/seaborn) - Statistical visualization * [bokeh](https://github.com/bokeh/bokeh) - Interactive web plotting # DevOps & Testing ## Testing * [pytest](https://docs.pytest.org/en/latest/) - Full-featured testing framework * [hypothesis](https://github.com/HypothesisWorks/hypothesis) - Property-based testing * [selenium](https://pypi.org/project/selenium/) - Web browser automation ## DevOps Tools * [ansible](https://github.com/ansible/ansible) - IT automation platform * [fabric](https://github.com/fabric/fabric) - Remote execution and deployment * [supervisor](https://github.com/Supervisor/supervisor) - Process control system # Command-Line Tools ## CLI Development * [click](https://github.com/pallets/click/) - Beautiful CLI interfaces * [python-prompt-toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit) - Interactive CLIs * [rich](https://github.com/Textualize/rich) - Rich text and formatting ## CLI Enhancements * [httpie](https://github.com/httpie/cli) - User-friendly HTTP client * [pgcli](https://github.com/dbcli/pgcli) - PostgreSQL CLI with autocomplete * [thefuck](https://github.com/nvbn/thefuck) - Corrects console commands ``` -------------------------------- ### Build Awesome Python Documentation Site - Make Commands Source: https://context7.com/vinta/awesome-python/llms.txt These make commands automate the process of setting up, previewing, and building the Awesome Python documentation website using MkDocs and the Material theme. They manage dependencies, serve the site locally for testing, and generate static site files for deployment. ```bash # Install dependencies make site_install # Or manually: pip install -r requirements.txt # Preview site locally at http://127.0.0.1:8000 make site_preview # Or manually: ln -sf $(pwd)/README.md $(pwd)/docs/index.md mkdocs serve # Build static site in site/ directory make site_build # Or manually: ln -sf $(pwd)/README.md $(pwd)/docs/index.md mkdocs build # Deploy to GitHub Pages make site_deploy ``` -------------------------------- ### Deploy Documentation Site with Makefile Source: https://context7.com/vinta/awesome-python/llms.txt This command utilizes a Makefile to deploy the project's documentation website. It automates the process of building and publishing the site, making updates accessible at the designated URL. This is a common practice for projects that host their documentation online. ```makefile make site_deploy ``` -------------------------------- ### Contribution Acceptance Workflow Source: https://context7.com/vinta/awesome-python/llms.txt Steps involved in reviewing and accepting contributions to the Awesome Python project, focusing on PR guidelines. ```bash # 1. Accepting contributions # - Review PR title follows "Add project-name" format # - Verify single addition per PR # - Check description is concise and ends with period # - Ensure alphabetical placement within category # - Confirm project is actively maintained ``` -------------------------------- ### Command-Line Browsing Strategies Source: https://context7.com/vinta/awesome-python/llms.txt Shell commands and strategies for searching the Awesome Python project's README file or using GitHub's file search. ```shell # Method 1: Search README.md directly grep -A 3 "## Machine Learning" README.md grep -B 2 "django" README.md # Method 2: Use GitHub's file search (press 't' on repository page) # Type category name or library name # Method 3: Browse the website # Visit https://awesome-python.com for searchable interface # Method 4: Clone and use local tools git clone https://github.com/vinta/awesome-python.git cd awesome-python # Use your favorite text editor with search capabilities ``` -------------------------------- ### MkDocs Configuration File (mkdocs.yml) Source: https://context7.com/vinta/awesome-python/llms.txt Configuration for the MkDocs static site generator. Defines site metadata, theme, social links, Google Analytics, custom CSS, and navigation structure. ```yaml site_name: Awesome Python site_url: https://awesome-python.com site_description: A curated list of awesome Python frameworks, libraries and software site_author: Vinta Chen repo_name: vinta/awesome-python repo_url: https://github.com/vinta/awesome-python theme: name: material palette: primary: red accent: pink extra: social: - type: github link: https://github.com/vinta - type: twitter link: https://twitter.com/vinta - type: linkedin link: https://www.linkedin.com/in/vinta google_analytics: - UA-510626-7 - auto extra_css: - css/extra.css nav: - "Life is short, you need Python.": "index.md" ``` -------------------------------- ### Awesome Python Repository Structure Source: https://context7.com/vinta/awesome-python/llms.txt Directory layout of the Awesome Python project, detailing key files and their purpose. ```bash awesome-python/ ├── README.md # Main curated list (70+ categories, 1000+ entries) ├── CONTRIBUTING.md # Contribution guidelines and rules ├── LICENSE # MIT License ├── Makefile # Build automation for documentation site ├── mkdocs.yml # MkDocs configuration for website ├── requirements.txt # Python dependencies (mkdocs, theme) ├── sort.py # Automatic alphabetical sorting script └── docs/ # Documentation directory (symlinked README) ├── index.md # Symlink to README.md └── css/ └── extra.css # Additional styling for website ``` -------------------------------- ### Contribute to Awesome Python - Markdown Format Source: https://context7.com/vinta/awesome-python/llms.txt This markdown format is used for adding new project entries to the Awesome Python list. Each entry links to a project and provides a concise description. It's a standardized way to contribute new resources to the curated list. ```markdown * [project-name](http://example.com/) - A short description ends with a period. ``` -------------------------------- ### Contribute to Awesome Python - Git Workflow Source: https://context7.com/vinta/awesome-python/llms.txt This bash script outlines the typical Git workflow for contributing a new project to the Awesome Python repository. It includes forking, cloning, adding entries to README.md, committing changes, and creating a pull request following specific naming conventions. ```bash # 1. Fork and clone the repository git clone https://github.com/YOUR_USERNAME/awesome-python.git cd awesome-python # 2. Add your entry in the appropriate category section # Edit README.md - Add ONE link per PR # Format: * [project-name](url) - Short description. # Example addition to the "Web Frameworks" section: # * [fastapi](https://github.com/tiangolo/fastapi) - A modern, fast web framework for building APIs with Python 3.6+. # 3. Create a pull request with title format: "Add project-name" git add README.md git commit -m "Add project-name" git push origin your-branch ``` -------------------------------- ### Sort Entries Alphabetically with Git and Python Source: https://context7.com/vinta/awesome-python/llms.txt This snippet demonstrates the process of updating local repository changes, running a Python script to sort entries alphabetically, staging the modified README, committing the changes, and pushing them to the remote master branch. It ensures the project's entries remain organized. ```shell git pull origin master python sort.py git add README.md git commit -m "Sort entries alphabetically" git push origin master ``` -------------------------------- ### Sort Awesome Python README - Python Script Source: https://context7.com/vinta/awesome-python/llms.txt This Python script, `sort.py`, is used to automatically sort library entries within the Awesome Python README.md file alphabetically. It parses the markdown structure, identifies list items, sorts them case-insensitively within their respective categories, and preserves the overall structure and non-list content. ```python # sort.py automatically handles: # - Preserving table of contents section # - Maintaining proper indentation for nested lists # - Sorting within category blocks while keeping structure # - Case-insensitive alphabetical ordering # - Preserving non-list content (headers, descriptions, links) # The algorithm: # 1. Reads README.md into memory # 2. Separates table of contents from content using '- - -' delimiter # 3. Clusters lines by indentation level # 4. Sorts only lines starting with '* [' or '- [' within clusters # 5. Preserves all other lines in original order # 6. Writes sorted result back to file ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.