##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
- Full scan of Python projects
- Specific extraction of code structure
- Identification of classes, functions, imports and doctrines
- Calculation of code complexity
- Use of advanced language models (Ollama/LLaMA)
- Automatic generation of:
- Project overview
- Summaries of individual files
- Description of interactions between modules
- JSON documentation for programmatic processing
- Markdown file for human reading
- HTML page for viewing in the browser
- Code Analysis: Python AST (Abstract Syntax Tree)
- AI: Ollama with LLaMA model
- Processing:
- Colorama (colored logs)
- tqdm (progress bars)
- markdown (document conversion)
- Time Saving: Automatic documentation in minutes
- Consistency: Standardized documentation
- Completeness: Deep code analysis
- Flexibility: Adaptable to different project structures
- Academic project documentation
- Developer onboarding
- Legacy code maintenance
- Software architecture analysis
- Support for more programming languages
- Integration with CI/CD tools
- Refinement of AI models
- Advanced documentation customization
Contributions are welcome! Please review the contribution guidelines before submitting pull requests.
MIT License