iang
/
ragger
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
RAG over files application
7 Commits 1 Branch 0 Tags 97 KiB
Python 100%
Go to file
Ian Griffin 96587513e7 better markdown parser 2024-10-28 14:00:07 +08:00
build/lib better markdown parser 2024-10-28 14:00:07 +08:00
ragger.egg-info better markdown parser 2024-10-28 14:00:07 +08:00
.gitignore initial commit 2024-10-28 10:46:26 +08:00
COPYING.md added license 2024-10-28 10:56:42 +08:00
README.md README fixes 2024-10-28 11:02:54 +08:00
pyproject.toml better markdown parser 2024-10-28 14:00:07 +08:00
ragger.py better markdown parser 2024-10-28 14:00:07 +08:00
requirements.txt better markdown parser 2024-10-28 14:00:07 +08:00
tesm.py better markdown parser 2024-10-28 14:00:07 +08:00
todo.txt better markdown parser 2024-10-28 14:00:07 +08:00

README.md

RAGger

ragger.py is a command line tool to RAG over multiple pieces of text, PDFs and websites using langchain and OpenAI.

The main repository is on git.telosama.xyz, where issues and contributions are accepted

Prerequisites

Since this codebase uses OpenAI models, a OpenAI API key is needed. After obtaining an API key, set the environment variable OPENAI_API_KEY to the API key. This program is built on top of python 3.10

Installation

This program can be installed by cloning the repository and installing the package using pip:

git clone gitea@git.telosama.xyz:iang/ragger.git
cd ragger
pip install .

Usage

To use the ragger command, open a terminal and run:

ragger file_1_path.pdf file_2_path.txt https://url_1_path.net