🤖 Self-Documentation Agent System

An AI-powered system that automatically analyzes, documents, and validates Python code using LangGraph workflows and Google's Gemini 2.5 Flash model.

✨ Features

  • 🧠 Intelligent Documentation: Adds comprehensive docstrings and comments
  • 🔍 Code Analysis: Identifies issues and provides recommendations
  • 🧪 Automated Testing: Executes code with various test scenarios
  • 📋 Professional Output: Clean, business-appropriate formatting
  • 🌐 Library Research: Uses web search to understand unfamiliar libraries

🚀 How to Use

  1. 🔑 Enter API Keys: Get your free keys from the links below
  2. 📝 Add Your Code: Paste Python code or use the sample
  3. ⚡ Process: Click "Analyze & Document Code"
  4. 📊 Review Results: Check documented code and analysis

💡 Tip: The system works best with functions, classes, and complete code snippets!

🔑 API Configuration

📝 Input Code

Ready to analyze code. Please provide your API keys and code.

📚 Documented Code

🔍 Analysis Results

Workflow Steps

  1. Research Node: Analyzes code structure, identifies libraries, and checks existing documentation
  2. Document Node: Adds comprehensive docstrings and inline comments using Google style
  3. Analyze Node: Executes code with various test scenarios and identifies potential issues
  4. Final Node: Saves results and provides summary

What You Get

  • Enhanced Code: Your original code with professional documentation
  • Detailed Analysis: Comprehensive testing results and recommendations
  • Issue Identification: Potential problems and improvement suggestions
  • Usage Guidelines: Instructions for implementation and testing

API Keys Required

  • Google API Key: Get it from Google AI Studio
  • Tavily API Key: Get it from Tavily for web search functionality

Technologies Used

  • LangGraph: Workflow orchestration and state management
  • Google Gemini 2.5 Flash: Advanced language model for analysis
  • Tavily Search: Web search for library research
  • Python AST: Code structure analysis
  • Code Execution Tools: Safe code testing environment

Supported Features

  • Function and class documentation
  • Inline code comments
  • Error handling analysis
  • Performance recommendations
  • Security issue identification
  • Test case generation
  • I/O behavior documentation