lluminy

lluminy — Automate Documentation For Python Projects

lluminy is an AI-powered tool designed to automatically generate and maintain documentation for Python codebases. It focuses on enriching code with docstrings derived from existing code and comments without altering the original logic. The solution integrates directly with GitHub to streamline documentation across repositories, making onboarding, maintenance, and collaboration more efficient.

---

Key Value

• Save time on documentation by generating docstrings for entire codebases within minutes.
• Preserve original code integrity by operating exclusively on docstrings and avoiding code modification.
• Improve developer onboarding and ongoing maintenance with well-documented functions and modules.
• Seamlessly fits into existing workflows through GitHub integration and pull request based publishing.

---

How It Works

1. Connect your GitHub account and select repositories.
2. Generate documentation for the entire codebase or for specific files/branches.
3. Choose whether to document all functions or only those missing docstrings.
4. Publish the results by creating a pull request with the generated docstrings.

Notes:

• Docstrings are generated without modifying the underlying code, reducing the risk of LLM hallucinations affecting behavior.
• Works across multiple files and whole projects, scalable from small to large codebases.

---

Features

• AI-powered docstring generation for Python code
• Documentation for entire codebases or selective files/directories/branches
• Option to document all functions or only those missing docstrings
• GitHub integration for repository selection and pull request creation
• Create pull requests with documentation changes automatically
• No changes to original codebase; documentation is added as docstrings only
• Supports multi-file and multi-project workflows
• Suitable for onboarding, maintenance, and collaboration across teams

---

How to Use lluminy

1. Connect GitHub: Link your GitHub account and authorize access.
2. Select Repositories: Choose which repositories or branches to document.
3. Configure Scope: Decide to document all functions or only those missing docstrings.
4. Generate & Publish: Generate docstrings and create a pull request with the results.

---

Pricing

• Try it out: Free plan with limited AI token usage
• Premium: For teams & production codebases at $20/month with a 10M/month AI token limit

---

Why Use lluminy

• Automates repetitive documentation tasks to accelerate onboarding and maintenance
• Keeps the codebase unchanged while providing comprehensive, discoverable documentation
• Integrates with GitHub to streamline collaboration and PR-based publishing

---

Core Features

• Documentation generation powered by LLama3.3
• Docstrings for entire codebase or selected files/branches
• GitHub integration for repository selection and PR creation
• Document all functions or only those missing docstrings
• Automated pull request creation to publish documentation
• Works with both personal and organization repositories