/AutoGenReadme

Primary LanguagePythonMIT LicenseMIT

AutoGenReadme: Unleash the Power of LLMs for Auto-magical READMEs

Tired of staring at a blank README file? Let AutoGenReadme be your AI co-pilot, crafting a captivating README tailored to your repo 🪄. Say goodbye to writer's block and hello to a polished first impression ✨.

⚡ Features that'll make you do a happy dance:

  • AutoGit: Clone and push repos with ease - no more terminal mumbo jumbo!
  • Organized Folders: Explore your project's directory structure like a pro, thanks to curated folder trees (see tree.txt for details).
  • LLM-powered README: Bard, the superpowered LLM, analyzes your code and whips up a stunning README in seconds (downloadable PDF and text formats!).
  • Streamlit UI: Tweak your README with a user-friendly interface!

Getting Started:

  1. Git it set up: Make sure your system is ready to rock with Git.
  2. Fuel the Bard: Create a credentials.json file with your API tokens (instructions inside).
  3. Let the magic unfold: Run streamlit run app.py and witness the README magic!

Dependencies:

  • matplotlib==3.7.2
  • numpy==1.24.2
  • pandas==1.5.3
  • plotly==5.15.0
  • pypdf==3.12.2
  • requests==2.31.0
  • urllib3==1.26.11
  • scikit-learn==1.2.2
  • streamlit==1.24.1
  • bardapi~=0.1.38
  • seedir~=0.4.2

Go forth and conquer the READMEverse!

AutoGenReadme takes the hassle out of README creation, letting you focus on what you do best - coding brilliance! So, dive in, generate your masterpiece, and share your project with the world .

P.S. Got feedback or suggestions? We're all ears (or should we say, eyes?) - hit us up on GitHub!