Install.sh & Install.bat. Readme Update

KruxAI · Jul 20, 2024 · d83a726 · d83a726
1 parent 6e7e017
commit d83a726
Show file tree

Hide file tree

Showing 27 changed files with 340 additions and 4,422 deletions.
diff --git a/.env-Sample b/.env-Sample
@@ -0,0 +1,10 @@
+# Description: Environment variables for the project. Rename to .env file for use
+OPENAI_API_KEY=XXXXXXXXX
+MISTRAL_API_KEY=XXXXXXXXX
+MIXPANEL_TOKEN=XXXXXXXXX
+HUGGINGFACEHUB_API_TOKEN=XXXXXXXXX
+COHERE_API_KEY=XXXXXXXXX
+JINA_API_KEY=XXXXXXXXX
+ENABLE_ANALYTICS=True
+SINGLESTOREDB_URL=userid:password@host:port/dbname
+PINECONE_API_KEY=XXXXXXXXX
diff --git a/Brewfile b/Brewfile
@@ -1,9 +1,3 @@
-# Brewfile
-
-# Taps
-tap "homebrew/core"
-
-# Core libraries
 brew "ca-certificates"
 brew "cairo"
 brew "fontconfig"
@@ -70,3 +64,4 @@ brew "unbound"
 brew "xorgproto"
 brew "xz"
 brew "zstd"
+brew "libheif"
diff --git a/Brewfile.lock.json b/Brewfile.lock.json
diff --git a/Brewfilelst.txt b/Brewfilelst.txt
diff --git a/Dockerfile b/Dockerfile
@@ -33,7 +33,7 @@ RUN pip install dist/*.gz
 WORKDIR /
 
 # Optionally, you can delete hidden files and directories as well
-RUN rm -rf ragbuilder
+RUN rm -rf ragbuilder/src
 WORKDIR /ragbuilder
 
 

diff --git a/InputFiles/arxiv.pdf b/InputFiles/arxiv.pdf
diff --git a/LICENSE b/LICENSE
@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright [2024] [KruxAI]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -21,12 +21,25 @@ RagBuilder is a toolkit designed to help you create optimal Production-ready Ret
 
 ## Installation
 
-### Option 1: Install using pip:
+### Option 1: Install using install script:
+#### Mac
 
 ```
-pip install ragbuilder
+curl -fsSL https://raw.githubusercontent.com/KruxAI/ragbuilder-readme/main/install.sh |bash
 ```
 
+#### Windows
+```
+curl -fsSL https://raw.githubusercontent.com/KruxAI/ragbuilder-readme/main/install.bat
+```
+
+Run Install.bat from command prompt
+```
+install.bat
+```
+
+
+
 #### Set your OpenAI API key
 
 Make sure your OpenAI API key is available by setting it as an environment variable. In MacOS and Linux, this is the command:
@@ -49,9 +62,14 @@ docker pull ashwinzyx/ragbuilder:latest
 ```
 
 Run the Docker Container.
-Create .env as below and use it while running the container
+Create .env as below and use it while running the container. The env file must be in the same directory where the docker command is being run
+#### Mac
+```
+docker run -it -v "$(pwd):/ragbuilder" --env-file .env -p 55003:8005 ashwinzyx/ragbuilder:latest
 ```
-docker run --env-file .env -p 55003:8005 ragbuilder
+#### Windows
+```
+docker run -d -v %cd%:/ragbuilder --env-file .env -p 55003:8005 ashwinzyx/ragbuilder
 ```
 
 OR
@@ -63,6 +81,8 @@ docker run  -p 55003:8005  -e OPENAI_API_KEY=sk-....
 
 Open Ragbuilder [http://localhost:55003/](http://localhost:55003/)
 
+If you are crearting your own synthetic dataset for evaluation, save the csv file in the same directory where the docker run command is being executed and provide the file name only
+
 ## Quickstart Guide
 
 Now, run ragbuilder on your command line:
@@ -140,4 +160,4 @@ PINECONE_API_KEY=XXXXXX
 4. Save the .env file.
 5. Ensure that the .env file is located in the same directory where you run the ragbuilder command to ensure the environment variables are properly loaded.
 
-By setting up these environment variables, you enable the RagBuilder project to authenticate and interact with the necessary external services.
+By setting up these environment variables, you enable the RagBuilder project to authenticate and interact with the necessary external services.
diff --git a/READMEold.md b/READMEold.md
diff --git a/..._for_ragas/docs-get_started-quickstart.md → ...InputFiles/docs-get_started-quickstart.md b/..._for_ragas/docs-get_started-quickstart.md → ...InputFiles/docs-get_started-quickstart.md
diff --git a/...n_for_ragas/docs-langsmith-walkthrough.md → ...eInputFiles/docs-langsmith-walkthrough.md b/...n_for_ragas/docs-langsmith-walkthrough.md → ...eInputFiles/docs-langsmith-walkthrough.md
diff --git a/..._ragas/docs-modules-agents-quick_start.md → ...tFiles/docs-modules-agents-quick_start.md b/..._ragas/docs-modules-agents-quick_start.md → ...tFiles/docs-modules-agents-quick_start.md
diff --git a/dockerignore b/dockerignore
@@ -3,4 +3,10 @@
 *.env
 *.csv
 *.log
-*.pyc
+*.pyc
+*.db
+
+
+!.env-Sample
+!.README.md
+!.LICENSE
diff --git a/install.bat b/install.bat
@@ -0,0 +1,17 @@
+echo Installing RagBuilder
+setlocal EnableDelayedExpansion
+
+echo Downloading Brewfile...
+curl -fsSL https://raw.githubusercontent.com/KruxAI/ragbuilder-readme/main/Brewfile -o Brewfile
+
+echo Reading Brewfile...
+echo Installing packages from Brewfile...
+for /f "usebackq tokens=*" %%i in ("Brewfile") do (
+    python -m pip install %%i
+)
+
+echo Installing ragbuilder...
+python -m pip install ragbuilder
+
+echo Setup completed successfully.
+endlocal
diff --git a/setup.py b/setup.py
@@ -4,13 +4,15 @@
     long_description = fh.read()
 setup(
     name='ragbuilder',
-    version='0.0.5',
+    version='0.0.6',
     author='Ashwin Aravind, Aravind Parameswaran',
     author_email='[email protected], [email protected]',
     description='RagBuilder is a toolkit designed to help you create optimal Production-ready Retrieval-Augmented Generation (RAG) pipeline for your data',
     long_description=long_description,
     long_description_content_type="text/markdown",
     url='https://github.com/kruxai/ragbuilder',
+    license='Apache 2.0',
+    license_files=('LICENSE',),
     package_dir={'': 'src'},
     packages=find_packages(where='src'),
     include_package_data=True,