/Github-Readme-File-Generator

Uses Agno framework with Kimi K2 model to generate a readme file for any repository on github

Primary LanguagePython

Funfact : This readme file is also generated by this project

🦆 GitHub README Generator

Fast, AI–driven README creation powered by Moonshot Kimi K2 & Agno

✨Try out here : https://readmegenerator.streamlit.app/

Python 3.13+ Streamlit App Built with License

✨ What it does

Clone any public GitHub repository, scan its structure, and get a production-ready README in seconds – all served in a simple Streamlit web app.

🚀 Quick start

Prerequisites

Local install

# 1. Clone the project
git clone https://github.com/<your-org>/bfwai-kimi-agno.git
cd bfwai-kimi-agno

# 2. Create and activate virtual env
python -m venv venv
source venv/bin/activate   # or .\venv\Scripts\activate on Windows

# 3. Install
pip install -r requirements.txt
# (or use `pip install .` with the supplied pyproject.toml)

# 4. Start the app
streamlit run main.py      # opens http://localhost:8501

🛠️ Usage

  1. Paste an OpenRouter API key in the sidebar
  2. Enter any public GitHub URL
  3. Click Generate README
  4. Copy the generated markdown or download as README.md

The tool respects .gitignore and never saves the repository after the session ends—everything is cleaned up automatically.

🧱 Tech stack

Layer Tooling / Library
Language Python 3.13
Framework Streamlit
LLM & routing OpenRouter → Moonshot AI/Kimi K2
Agent runtime Agno
Git bindings GitPython
Package mgmt pyproject.toml

🤝 Contributing

  1. Fork the repo
  2. Create a feature branch: git checkout -b my-feature
  3. Add tests for new logic (pytest preferred)
  4. Ensure linting passes: 
    ruff check .
ruff format .
  5. Push & open a Pull Request
  6. Your change will be reviewed and merged. Thanks!

Made with ❤️ by Build Fast with AI