docmakerai 0.1.4

Generate documentation for your repository

📄 codereviewer

AI-powered documentation generator for GitHub repositories — fetch, extract, and document any repo in seconds.

---

✨ Features

• 🔍 Fetches repository information directly from GitHub
• 📂 Extracts and filters relevant source files
• 🤖 Uses AI (Gemini + Groq) to generate human-readable documentation

---

🛠️ Tech Stack

Layer	Technology
Language	Python 3.12+
AI Providers	Gemini, Groq
Core Deps	gemini, git_pull, regex, scouter, doc_writer, groq

---

⚙️ Requirements

• Python 3.12+
• GEMINI_API_KEY — Get it here
• GROQ_API_KEY — Get it here
• TOKEN — Personal GitHub access token

---

🚀 Installation

# 1. Clone the repository
git clone https://github.com/Abbos1308/Documentation-Maker-AI.git
cd codereviewer

# 2. Create and activate a virtual environment
python -m venv myenv
source myenv/bin/activate        # Linux/Mac
# myenv\Scripts\activate         # Windows

# 3. Install the package
pip install .

# 4. Set environment variables
export GEMINI_API_KEY=your_gemini_key
export GROQ_API_KEY=your_groq_key
export TOKEN=your_github_token

---

⚡ Quickstart

python main.py https://github.com/owner/repo.git

Or use it programmatically:

from doc_writer import doc_maker

print(doc_maker("https://github.com/owner/repo.git"))

---

🔧 Configuration

All configuration is done via environment variables:

Variable	Description	Required
GEMINI_API_KEY	Gemini API Key	✅ Yes
GROQ_API_KEY	Groq API Key	✅ Yes
TOKEN	Personal GitHub access token	✅ Yes

---

📁 Project Structure

codereviewer/
├── main.py          # Entry point — run from CLI
├── doc_writer.py    # Core documentation generation logic
└── pyproject.toml   # Project metadata & dependencies

---

📖 API Reference

doc_maker(link: str) -> str

Generates documentation for a given GitHub repository.

Parameters:

Name	Type	Description
link	str	Full URL of the GitHub repository

Returns: str — The generated documentation.

Example:

from doc_writer import doc_maker

docs = doc_maker("https://github.com/owner/repo.git")
print(docs)

---

❗ Error Reference

Error Message	Cause
ERROR: Failed to fetch repository. Could be deleted or private. Please check and retry	Repo is private, deleted, or the token is invalid
ERROR: Failed to connect with AI. Please try again in few minutes	AI service is unreachable or rate-limited