Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 1.92 KB

README.md

File metadata and controls

81 lines (55 loc) · 1.92 KB

License

GitDigest 🔍

Turn any GitHub repository into a prompt-friendly text digest for LLMs.

🚀 Features

  • One-Click Analysis: Simply paste a GitHub repository URL and get instant results
  • Smart Formatting: Optimized output format for LLM prompts
  • Statistics about: :
    • File and directory structure
    • Token counts and statistics
    • Repository summary
  • Web Interface: Clean, responsive UI built with Tailwind CSS

🛠️ Tech Stack

  • FastAPI - Backend framework
  • codebase-digest - Core analysis engine
  • apianalytics.dev - Usage tracking

📦 Installation

  1. Clone the repository:
git clone https://github.com/yourusername/gitdigest.git
cd gitdigest
  1. Install dependencies:
pip install -r requirements.txt
  1. Set up environment variables:
# Create .env file
touch .env

# Add your API analytics key
echo "API_ANALYTICS_KEY=your_key_here" >> .env
  1. Run the application:
cd src
uvicorn main:app --reload

The application will be available at http://localhost:8000

🔒 WIP

  • Repository cloning is limited to GitHub repositories only
  • Processing timeouts are implemented (10s for cloning, 15s for processing)
  • Temporary files are automatically cleaned up after processing
  • Request size limits are in place to prevent abuse

🤝 Contributing

Contributions are welcome! Feel free to:

  1. Fork the repository
  2. Create a feature branch
  3. Submit a pull request

For feature suggestions, please open an issue first to discuss what you would like to add.

📫 Contact

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.