https://github.com/rashi-raturi/readme-generator
A streamlit app that generates readme file for your project using llama-3 & groq API
https://github.com/rashi-raturi/readme-generator
generative-ai groq-api llama3 readme readme-generator streamlit
Last synced: 3 months ago
JSON representation
A streamlit app that generates readme file for your project using llama-3 & groq API
- Host: GitHub
- URL: https://github.com/rashi-raturi/readme-generator
- Owner: rashi-raturi
- Created: 2024-08-26T08:56:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-27T11:03:28.000Z (about 1 year ago)
- Last Synced: 2025-01-31T03:26:46.855Z (8 months ago)
- Topics: generative-ai, groq-api, llama3, readme, readme-generator, streamlit
- Language: Python
- Homepage: https://read-me.streamlit.app
- Size: 21.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# README Generator
Description:
------------
The ReadMe Generator is a project that uses Streamlit and the LLaMA model to generate a README file for a given project. It allows users to input project details, upload files, and generate a README file with a preview option.
Features:
--------
* Generate a README file for a given project
* Input project details and upload files
* Toggle between Markdown and Code views
* Support for multiple file uploads
Installation Instructions:
-------------------------
1. Install the required dependencies:
* Streamlit
* Groq
* dotenv
2. Clone the repository and navigate to the project directory
3. Run the application using `streamlit run app.py`
Usage Instructions:
-----------------
1. Open the application in your web browser
2. Input project details and upload files as desired
3. Click the "Generate" button to generate the README file
4. Toggle between Markdown and Code views using the preview button
Code Structure:
--------------
The project consists of the following files and directories:
* `app.py`: The main application file that sets up the Streamlit app and calls the `mainView` function
* `readme.py`: The file that contains the UI for the app
* `extractMarkdown.py`: The file that extracts code blocks from the generated Markdown content
* `readme_gen.py`: The file that contains the LLaMA model and generates the README file
Future Enhancements:
-------------------
* Improve the user interface and user experience
* Add more features to the README generator
Credits/References:
-------------------
* Streamlit: A popular Python library for building web applications
* LLaMA model: A large language model developed by Meta AI
* Groq: A Python library for interacting with the LLaMA model
* dotenv: A Python library for loading environment variables from a `.env` file