{"id":23908171,"url":"https://github.com/ahammadnafiz/reporag","last_synced_at":"2025-02-23T15:15:36.885Z","repository":{"id":270981812,"uuid":"912034797","full_name":"ahammadnafiz/RepoRAG","owner":"ahammadnafiz","description":"A fully interactive tool designed to streamline your GitHub repository prompt generation process and facilitate RAG (Retrieval-Augmented Generation) workflows","archived":false,"fork":false,"pushed_at":"2025-01-05T12:12:54.000Z","size":227,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-23T15:15:33.532Z","etag":null,"topics":["ai","app","code","github","ingestion","langchain","llm","open-source","prompt","python","rag","repository","retrieval-augmented-generation"],"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/ahammadnafiz.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":"2025-01-04T14:11:02.000Z","updated_at":"2025-02-16T10:45:06.000Z","dependencies_parsed_at":"2025-01-04T15:25:32.556Z","dependency_job_id":"077b293b-d50c-4eed-b595-dc151553f448","html_url":"https://github.com/ahammadnafiz/RepoRAG","commit_stats":null,"previous_names":["ahammadnafiz/reporag"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahammadnafiz%2FRepoRAG","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahammadnafiz%2FRepoRAG/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahammadnafiz%2FRepoRAG/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahammadnafiz%2FRepoRAG/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahammadnafiz","download_url":"https://codeload.github.com/ahammadnafiz/RepoRAG/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240331362,"owners_count":19784646,"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","app","code","github","ingestion","langchain","llm","open-source","prompt","python","rag","repository","retrieval-augmented-generation"],"created_at":"2025-01-05T04:25:12.061Z","updated_at":"2025-02-23T15:15:36.861Z","avatar_url":"https://github.com/ahammadnafiz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Banner](assets/banner.png)\n\n\n\u003ch1 align=\"center\"\u003eRepoRAG\u003c/h1\u003e\n\nA fully interactive tool designed to streamline your GitHub repository prompt generation process and facilitate RAG (Retrieval-Augmented Generation) workflows\n\n\n## 🏗️ System Design \u0026 Architecture\n- Below is the high-level architecture of the system:\n\n![Flow](assets/reporagai_2.jpeg)\n![Architecture](assets/reporagai_1.jpeg)\n\n\n## 📌 Table of Contents\n- [🌟 Features](#-features)\n- [🛠️ Installation](#️-installation)\n- [🚀 Usage](#-usage)\n- [⚙️ Configuration](#%EF%B8%8F-configuration)\n- [📖 Interactive Commands](#-interactive-commands)\n- [🎨 Icons and Badges](#-icons-and-badges)\n- [🧪 Example](#-example)\n- [🤖 Technologies Used](#-technologies-used)\n- [📃 License](#-license)\n- [🤝 Contributing](#-contributing)\n\n---\n\n## 🌟 Features\n- **Interactive Mode**: Easily input repository details and start generating prompts through a user-friendly interface.\n- **RAG Support**: Engage in interactive Retrieval-Augmented Generation sessions with real-time question answering about your repositories.\n- **Environment Variable Management**: Supports environment-based configurations for quick and seamless setup.\n- **Error Handling**: Robust error handling to ensure smooth operations during interactive sessions.\n- **Clear Command Interface**: Offers a set of easy-to-use commands for RAG sessions, including options to clear history or exit the session.\n\n---\n\n## 🛠️ Installation\n\nFollow these steps to get started with RepoRAG:\n\n1. **Clone the repository**:\n```bash\n$ git clone https://github.com/ahammadnafiz/RepoRAG.git\n```\n\n2. **Navigate to the project directory**:\n```bash\n$ cd RepoRAG\n```\n\n3. **Install the required dependencies**:\n```bash\n$ pip install -r requirements.txt\n```\n\n4. **Create a `.env` file** to store your environment variables (see [Configuration](#%EF%B8%8F-configuration)).\n\n5. **Download NLTK Data** \n```python\npython -c \"import nltk; nltk.download('punkt'); nltk.download('stopwords'); nltk.download('wordnet')\"\n```\n\n---\n\n## 🚀 Usage\n\nRun the interactive mode directly from your terminal:\n```bash\n$ python reporag.py\n```\n\n### 🧑‍💻 Interactive Session Walkthrough:\n- **Step 1**: Enter the repository URL in the format `owner/repo`.\n- **Step 2**: Provide your GitHub access token.\n- **Step 3**: Specify the output file name for the generated prompt.\n- **Step 4**: Choose the desired mode:\n  - `1`: Generate a prompt file only.\n  - `2`: Generate a prompt file and start a RAG session.\n\n---\n\n## ⚙️ Configuration\n\nCreate a `.env` file in the root directory to store your environment variables:\n```env\nGITHUB_ACCESS_TOKEN=your_github_token\nGROQ_API_KEY=your_groq_api_key\n```\n\n**Environment Variables Explained**:\n- `GITHUB_ACCESS_TOKEN`: Your personal GitHub token for accessing private repositories.\n- `GROQ_API_KEY`: API key required for advanced RAG functionalities.\n\n---\n\n## 📖 Interactive Commands\nWhen running in RAG mode, you can use the following commands:\n\n| Command | Description                    |\n| ------- | ------------------------------ |\n| `exit`  | Exit the RAG session           |\n| `help`  | Display available commands     |\n| `clear` | Clear the conversation history |\n\n---\n\n## 🎨 Icons and Badges\n\n![Python](https://img.shields.io/badge/python-v3.8%2B-blue) ![GitHub](https://img.shields.io/badge/github-RepoRAG-lightgrey)\n\n**Supported Technologies**:\n- Python 3.8+\n- GitHub API\n- dotenv for environment variable management\n\n---\n\n## 🧪 Example\n\n```bash\n=== RepoRAG Interactive Mode ===\n\nEnter the GitHub repository URL (format: owner/repo): ahammadnafiz/RepoRAG\nGitHub access token not found in .env. Please enter your token: ********\nEnter the output file name for the prompt (e.g., output_prompt.txt): my_prompt.txt\nAvailable modes:\n1. Generate prompt file only\n2. Generate prompt file and start RAG mode\nEnter your choice (1/2): 2\n```\n\n---\n\n## 🤖 Technologies Used\n- **Python**: Core language for the tool.\n- **dotenv**: For environment variable management.\n- **Typing**: Used for type hints and validation.\n- **GitHub API**: To interact with GitHub repositories.\n\n---\n\n## 📃 License\n\nThis project is licensed under the MIT License. See the [LICENSE](https://github.com/ahammadnafiz/RepoRAG/blob/main/LICENSE) file for details.\n\n---\n\n## 🤝 Contributing\n\nWe welcome contributions to RepoRAG! Please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature/your-feature`).\n3. Commit your changes (`git commit -m 'Add your feature'`).\n4. Push to the branch (`git push origin feature/your-feature`).\n5. Create a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahammadnafiz%2Freporag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahammadnafiz%2Freporag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahammadnafiz%2Freporag/lists"}