What is lluminy?
lluminy is an AI-powered tool designed to automate the process of writing documentation for Python projects. It leverages AI to generate docstrings, saving developers significant time and effort. The algorithm ensures the original code remains unmodified, working exclusively with docstrings and handling multiple files or entire projects.
lluminy seamlessly integrates with GitHub. Users can connect their GitHub account, select repositories, and generate code comments with a few clicks, creating a pull request with the results. A GitHub bot (currently in development) will soon provide automated documentation suggestions for pull requests.
Features
- Docstring Generation: Automatically generates docstrings for Python code.
- GitHub Integration: Seamlessly connects with GitHub repositories.
- Selective Documentation: Choose to document all functions or only those missing docstrings.
- Bulk Processing: Handles multiple files and entire projects.
- Code Preservation: Ensures the original code remains unmodified.
Use Cases
- Automating Python code documentation.
- Speeding up developer onboarding.
- Simplifying codebase maintenance.
- Enhancing dev team collaboration.
- Generating documentation for large Python projects.
