ragxo 0.1.9__tar.gz → 0.1.11__tar.gz

{ragxo-0.1.9 → ragxo-0.1.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ragxo
-Version: 0.1.9
+Version: 0.1.11
 Summary: A RAG (Retrieval-Augmented Generation) toolkit with Milvus integration
 Home-page: https://github.com/yourusername/ragx
 License: MIT
@@ -17,6 +17,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: alive-progress (>=3.1.1,<4.0.0)
 Requires-Dist: boto3 (>=1.36.14,<2.0.0)
 Requires-Dist: dill (>=0.3.9,<0.4.0)
 Requires-Dist: milvus (>=2.3.9,<3.0.0)
@@ -30,7 +31,7 @@ Description-Content-Type: text/markdown
 
 # RagXO
 
-Export, version and reuse your RAG pipeline everywhere 🚀
+Export, version and reuse your E2E RAG pipeline everywhere 🚀
 
 [![PyPI version](https://badge.fury.io/py/ragxo.svg)](https://badge.fury.io/py/ragxo)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -57,20 +58,26 @@ pip install ragxo
 
 ### Build a RAG pipeline
 
+```bash
+export OPENAI_API_KEY=<openai_key> 
+```
+
 ```python
 from ragxo import Ragxo, Document
 
-def preprocess_text_lower(text: str) -> str:
-    return text.lower()
+
+
+ragxo_client = Ragxo(dimension=1536)
 
 def preprocess_text_remove_special_chars(text: str) -> str:
     return re.sub(r'[^a-zA-Z0-9\s]', '', text)
 
+def preprocess_text_lower(text: str) -> str:
+    return text.lower()
+
 def get_embeddings(text: str) -> list[float]:
     return openai.embeddings.create(input=text, model="text-embedding-ada-002").data[0].embedding
 
-ragxo_client = Ragxo(dimension=768)
-
 ragxo_client.add_preprocess(preprocess_text_lower)
 ragxo_client.add_preprocess(preprocess_text_remove_special_chars)
 ragxo_client.add_embedding_fn(get_embeddings)
@@ -94,6 +101,9 @@ ragxo_client.index([
 
 ragxo_client.export("my_rag_v1.0.0")
 
+# or export to s3
+ragxo_client.export("my_rag_v1.0.0", s3_bucket="my_bucket")
+
 ```
 
 
@@ -107,6 +117,7 @@ vector_search_results = loaded_ragxo_client.query("What is the capital of France
 llm_response = loaded_ragxo_client.generate_llm_response(
     "What is the capital of France?")
 
+print(llm_response.choices[0].message.content)
 ```
 
 
@@ -226,3 +237,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 ## Contributing 🤝
 
 Contributions are welcome! Please feel free to submit a Pull Request.
+

{ragxo-0.1.9 → ragxo-0.1.11}/README.md

@@ -1,6 +1,6 @@
 # RagXO
 
-Export, version and reuse your RAG pipeline everywhere 🚀
+Export, version and reuse your E2E RAG pipeline everywhere 🚀
 
 [![PyPI version](https://badge.fury.io/py/ragxo.svg)](https://badge.fury.io/py/ragxo)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -27,20 +27,26 @@ pip install ragxo
 
 ### Build a RAG pipeline
 
+```bash
+export OPENAI_API_KEY=<openai_key> 
+```
+
 ```python
 from ragxo import Ragxo, Document
 
-def preprocess_text_lower(text: str) -> str:
-    return text.lower()
+
+
+ragxo_client = Ragxo(dimension=1536)
 
 def preprocess_text_remove_special_chars(text: str) -> str:
     return re.sub(r'[^a-zA-Z0-9\s]', '', text)
 
+def preprocess_text_lower(text: str) -> str:
+    return text.lower()
+
 def get_embeddings(text: str) -> list[float]:
     return openai.embeddings.create(input=text, model="text-embedding-ada-002").data[0].embedding
 
-ragxo_client = Ragxo(dimension=768)
-
 ragxo_client.add_preprocess(preprocess_text_lower)
 ragxo_client.add_preprocess(preprocess_text_remove_special_chars)
 ragxo_client.add_embedding_fn(get_embeddings)
@@ -64,6 +70,9 @@ ragxo_client.index([
 
 ragxo_client.export("my_rag_v1.0.0")
 
+# or export to s3
+ragxo_client.export("my_rag_v1.0.0", s3_bucket="my_bucket")
+
 ```
 
 
@@ -77,6 +86,7 @@ vector_search_results = loaded_ragxo_client.query("What is the capital of France
 llm_response = loaded_ragxo_client.generate_llm_response(
     "What is the capital of France?")
 
+print(llm_response.choices[0].message.content)
 ```
 
 
@@ -195,4 +205,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## Contributing 🤝
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+Contributions are welcome! Please feel free to submit a Pull Request.

{ragxo-0.1.9 → ragxo-0.1.11}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ragxo"
-version = "0.1.9"
+version = "0.1.11"
 description = "A RAG (Retrieval-Augmented Generation) toolkit with Milvus integration"
 authors = ["Mohamed Sadek <mohamedfawzydes@gmail.com>"]
 readme = "README.md"
@@ -28,6 +28,7 @@ openai = "^1.61.1"
 boto3 = "^1.36.14"
 pytest-mock = "^3.14.0"
 mocker = "^1.1.1"
+alive-progress = "^3.1.1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.3.4"

{ragxo-0.1.9 → ragxo-0.1.11}/ragxo/client.py

@@ -11,6 +11,7 @@ import tempfile
 from botocore.exceptions import ClientError
 import openai
 from openai import ChatCompletion
+from ragxo.utils import with_loading
 
 logger = logging.getLogger(__name__)
 
@@ -140,6 +141,7 @@ class Ragxo:
         self.presence_penalty = presence_penalty
         return self
     
+    @with_loading("Indexing documents")
     def index(self, data: list[Document]) -> Self:
         """
         Index documents into the vector database.
@@ -210,6 +212,7 @@ class Ragxo:
             output_fields=output_fields
         )
 
+    @with_loading("Exporting Ragxo instance")
     def export(self, destination: str, s3_bucket: str = None) -> Self:
         """
         Export the Ragx instance to either local filesystem or S3.

ragxo-0.1.11/ragxo/utils.py

@@ -0,0 +1,21 @@
+import functools
+from alive_progress import alive_bar
+
+
+def with_loading(title: str):
+    """
+    Decorator to add loading animation to methods.
+    
+    Args:
+        title (str): Title to display during loading
+    """
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(self, *args, **kwargs):
+            with alive_bar(title=title, bar=None, stats=False) as bar:
+                result = func(self, *args, **kwargs)
+                bar()
+            return result
+        return wrapper
+    return decorator