https://github.com/codecaine-zz/python_std_examples

Python Standard Library by Example using AI
https://github.com/codecaine-zz/python_std_examples

documentation library llama3 ollama python3 standard standard-library stl

Last synced: 10 days ago
JSON representation

Python Standard Library by Example using AI

• Host: GitHub
• URL: https://github.com/codecaine-zz/python_std_examples
• Owner: codecaine-zz
• Created: 2024-12-03T20:21:28.000Z (28 days ago)
• Default Branch: main
• Last Pushed: 2024-12-18T19:13:46.000Z (13 days ago)
• Last Synced: 2024-12-18T20:20:36.809Z (13 days ago)
• Topics: documentation, library, llama3, ollama, python3, standard, standard-library, stl
• Language: HTML
• Homepage: https://codefreelance.net/apps/python_std_bible/
• Size: 2.86 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
Python standard library code examples using AI

This application generates code examples for Python's standard library modules using AI. The code examples are generated using the qwen2.5-coder:3b model.

## How to Use

1. Ensure you have the necessary dependencies installed.

2. Make sure the `ollama` service is running.

3. Run the `main.py` script to generate the code examples.

4. The generated markdown files will be saved in the `standard_library_documents` directory.

5. . If files already exist, they will not be replaced or processed. You can delete the existing files and run the program again to regenerate them.

6. You can add more modules to the standard library dictionary to generate examples for additional modules.

7. **Generate HTML Version:** Run the `create_html_version.py` script to convert the generated markdown files into a single HTML document. This HTML file will be saved in the `html_version` folder and will include categorized links and a scroll-to-top button for easy navigation.

   ![Screenshot categories](screenshots/screenshot1.png)

   ![Screenshot modules](screenshots/screenshot2.png)

   ![Github markdown viewer](screenshots/screenshot3.png)

## Application Demo

Check out the demo of this application [here](https://codefreelance.net/apps/python_std_bible/).

### Development Notes

You can use Copilot edits to refactor the `standard_library_documents` to improve examples if needed.