{"id":26428997,"url":"https://github.com/cactusquill/ai-docgen","last_synced_at":"2025-03-18T04:52:50.977Z","repository":{"id":276121747,"uuid":"909790465","full_name":"CactusQuill/AI-DocGen","owner":"CactusQuill","description":"📸 ScreenDoc: Automate professional documentation generation from screen recordings using AI.","archived":false,"fork":false,"pushed_at":"2025-03-16T11:35:14.000Z","size":119829,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-16T12:28:30.977Z","etag":null,"topics":["ai","documentation","gemini","llm","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CactusQuill.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-29T19:27:40.000Z","updated_at":"2025-03-16T11:35:18.000Z","dependencies_parsed_at":"2025-02-06T12:42:56.992Z","dependency_job_id":null,"html_url":"https://github.com/CactusQuill/AI-DocGen","commit_stats":null,"previous_names":["cactusquill/ai-docgen"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CactusQuill%2FAI-DocGen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CactusQuill%2FAI-DocGen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CactusQuill%2FAI-DocGen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CactusQuill%2FAI-DocGen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CactusQuill","download_url":"https://codeload.github.com/CactusQuill/AI-DocGen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244159992,"owners_count":20408019,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","documentation","gemini","llm","python"],"created_at":"2025-03-18T04:52:50.557Z","updated_at":"2025-03-18T04:52:50.971Z","avatar_url":"https://github.com/CactusQuill.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AI-DocGen 📸 - Automated Process Documentation Tool\n\n\n![AI-DocGen Logo](images/logo.png)\n\n\n\nAI-DocGen is a powerful Python-based tool that automatically generates professional documentation from screen recordings. It uses AI to detect steps, analyze screenshots, and create detailed documentation in multiple formats.\n\n## 🌟 Features\n\n- **Automated Screen Recording**: Capture your process with high-quality screen recording\n- **Smart Step Detection**: Automatically identifies distinct steps in your workflow\n- **AI-Powered Descriptions**: Generates detailed descriptions for each step using Google's Gemini Vision API\n- **Multiple Output Formats**: Generate documentation in PDF, HTML, or Markdown\n- **Interactive UI**: User-friendly Streamlit interface for easy recording and configuration\n- **Customizable Sensitivity**: Adjust step detection parameters to match your needs\n- **Professional Output**: Clean, well-formatted documentation with images and descriptions\n\n## 🚀 Quick Start\n\n### Prerequisites\n\n- Python 3.8 or higher\n- FFmpeg (for video processing)\n- Google Cloud account with Gemini Vision API access\n\n### Installation\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/CactusQuill/AI-DocGen.git\n   cd AI-DocGen\n   ```\n\n2. Create and activate a virtual environment:\n   ```bash\n   python -m venv venv\n   # Windows\n   .\\venv\\Scripts\\activate\n   # Linux/Mac\n   source venv/bin/activate\n   ```\n\n3. Install dependencies:\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n4. Install FFmpeg:\n   - Windows: Download from [FFmpeg website](https://ffmpeg.org/download.html) and add to PATH\n   - Linux: `sudo apt-get install ffmpeg`\n   - Mac: `brew install ffmpeg`\n\n5. Set up environment variables:\n   - Create a `.env` file in the project root\n   - Add your Gemini API key:\n     ```\n     GEMINI_API_KEY=your_api_key_here\n     MODEL_NAME=gemini-vision-1.5\n     ```\n\n### Usage\n\n1. Start the application:\n   ```bash\n   streamlit run app.py\n   ```\n\n2. In the web interface:\n   - Click \"Start Recording\" to begin capturing your screen\n   - Perform the process you want to document\n   - Click \"Stop Recording\" when finished\n   - Adjust step detection settings if needed\n   - Generate documentation in your preferred format\n\n## 🛠️ Configuration\n\n### Step Detection Settings\n\n- **Similarity Threshold** (0.0-1.0): Controls how different two frames need to be to be considered separate steps\n- **Minimum Time Between Steps** (seconds): Minimum time that must pass between detected steps\n\n### Output Formats\n\n1. **PDF**\n   - Professional layout with table of contents\n   - Embedded images and formatted text\n   - Page numbers and headers\n\n2. **HTML**\n   - Responsive design\n   - Interactive table of contents\n   - Print-friendly styling\n\n3. **Markdown**\n   - GitHub-compatible format\n   - Easy to version control\n   - Convertible to other formats\n\n## 🤝 Contributing\n\nWe welcome contributions! Please follow these steps:\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n### Development Setup\n\n1. Install development dependencies:\n   ```bash\n   pip install -r requirements-dev.txt\n   ```\n\n2. Run tests:\n   ```bash\n   pytest\n   ```\n\n3. Check code style:\n   ```bash\n   flake8\n   black .\n   ```\n\n## 📝 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgments\n\n- Google Gemini Vision API for AI-powered image analysis\n- Streamlit for the amazing web interface framework\n- FFmpeg for video processing capabilities\n- All our contributors and users\n\n## 📚 Documentation\n\nFor detailed documentation, visit our [Wiki](https://github.com/CactusQuill/AI-DocGen/wiki).\n\n## 🐛 Troubleshooting\n\n### Common Issues\n\n1. **Video Playback Issues**\n   - Ensure FFmpeg is properly installed\n   - Check video codec compatibility\n   - Try converting the video manually using FFmpeg\n\n2. **Step Detection Problems**\n   - Adjust similarity threshold\n   - Increase minimum time between steps\n   - Check if screen changes are significant enough\n\n3. **API Issues**\n   - Verify API key is correct\n   - Check API quota and limits\n   - Ensure internet connectivity\n\n### Getting Help\n\n- Open an [Issue](https://github.com/CactusQuill/AI-DocGen/issues)\n- Check existing [Discussions](https://github.com/CactusQuill/AI-DocGen/discussions)\n- Read our [FAQ](https://github.com/CactusQuill/AI-DocGen/wiki/FAQ)\n\n## 🔄 Updates\n\nStay updated with new releases:\n- Watch this repository\n- Follow our [Release Notes](https://github.com/CactusQuill/AI-DocGen/releases)\n\n## 📊 Project Status\n\nAI-DocGen is under active development. We're working on:\n- [ ] Multi-monitor support\n- [ ] Custom documentation templates\n- [ ] Cloud storage integration\n- [ ] Batch processing\n- [ ] API endpoint for programmatic access\n\n## 💡 Feature Requests\n\nHave an idea? We'd love to hear it!\n1. Check existing [Feature Requests](https://github.com/CactusQuill/AI-DocGen/labels/enhancement)\n2. Open a new [Discussion](https://github.com/CactusQuill/AI-DocGen/discussions/new)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcactusquill%2Fai-docgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcactusquill%2Fai-docgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcactusquill%2Fai-docgen/lists"}