Automatic Documentation Generator for Python Projects

##Overview

This project is an innovative automated documentation tool that uses static code analysis and artificial intelligence to generate comprehensive technical documents for Python projects.

##Main Features

Advanced Code Analysis

• Full scan of Python projects
• Specific extraction of code structure
• Identification of classes, functions, imports and doctrines
• Calculation of code complexity

AI-powered Documentation Generation

• Use of advanced language models (Ollama/LLaMA)
• Automatic generation of:
• Project overview
• Summaries of individual files
• Description of interactions between modules

Multiple Output Formats

• JSON documentation for programmatic processing
• Markdown file for human reading
• HTML page for viewing in the browser

Technologies Used

• Code Analysis: Python AST (Abstract Syntax Tree)
• AI: Ollama with LLaMA model
• Processing:
• Colorama (colored logs)
• tqdm (progress bars)
• markdown (document conversion)

Benefits

1. Time Saving: Automatic documentation in minutes
2. Consistency: Standardized documentation
3. Completeness: Deep code analysis
4. Flexibility: Adaptable to different project structures

Use Cases

• Academic project documentation
• Developer onboarding
• Legacy code maintenance
• Software architecture analysis

Next Steps

• Support for more programming languages
• Integration with CI/CD tools
• Refinement of AI models
• Advanced documentation customization

Contribution

Contributions are welcome! Please review the contribution guidelines before submitting pull requests.

License

MIT License