pirag 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

app/main.py

@@ -62,7 +62,10 @@ def main():
     command_message = f"with command: {args.command}" if args.command else ""
     logger.info(f"RAG Started {command_message}")
     
-    setup_logger(args.log_level)
+    setup_logger(
+        log_level = args.log_level,
+        log_dir = args.log_dir,
+    )
     logger.debug(f"Parsed arguments: {args}")
 
     if args.command == 'doctor':

app/rag/ask/__init__.py

@@ -0,0 +1,2 @@
+from .config import parser, help
+from .router import route

app/rag/ask/config.py

@@ -0,0 +1,9 @@
+import argparse
+
+help = "Ask a question to the RAG system."
+
+parser = argparse.ArgumentParser(
+    description = f"{help} Queries the knowledge base with natural language questions, retrieves relevant context, and generates accurate, contextually-aware responses based on the retrieved information",
+    add_help = False,
+    formatter_class = argparse.ArgumentDefaultsHelpFormatter,
+)

app/rag/ask/router.py

@@ -0,0 +1,4 @@
+from argparse import Namespace
+
+def route(args: Namespace):
+    print(args)

app/rag/config.py

@@ -3,34 +3,35 @@ from pathlib import Path
 from loguru import logger
 
 # Logger format constants
-TIME_FORMAT = "{time:YYYY-MM-DD HH:mm:ss.SSS!UTC}Z"
-FILE_FORMAT = f"{TIME_FORMAT} | {{level: <8}} | {{name}}:{{function}}:{{line}} - {{message}}"
-CONSOLE_FORMAT_FULL = f"<green>{TIME_FORMAT}</green> | <level>{{level: <8}}</level> | <cyan>{{name}}</cyan>:<cyan>{{function}}</cyan>:<cyan>{{line}}</cyan> - <level>{{message}}</level>\n"
-CONSOLE_FORMAT_SIMPLE = f"<green>{TIME_FORMAT}</green> | <level>{{level: <8}}</level> | <level>{{message}}</level>\n"
+LOG_TIME_FORMAT = "{time:YYYY-MM-DD HH:mm:ss.SSS!UTC}Z"
+LOG_FILE_FORMAT = f"{LOG_TIME_FORMAT} | {{level: <8}} | {{name}}:{{function}}:{{line}} - {{message}}"
+LOG_CONSOLE_FORMAT_FULL = f"<green>{LOG_TIME_FORMAT}</green> | <level>{{level: <8}}</level> | <cyan>{{name}}</cyan>:<cyan>{{function}}</cyan>:<cyan>{{line}}</cyan> - <level>{{message}}</level>\n"
+LOG_CONSOLE_FORMAT_SIMPLE = f"<green>{LOG_TIME_FORMAT}</green> | <level>{{level: <8}}</level> | <level>{{message}}</level>\n"
 
 # Initial logger setup before setup_logger()
 logger.remove()
 logger.add(
     sink = sys.stderr,
     level = "INFO", 
-    format = lambda record: CONSOLE_FORMAT_SIMPLE if record["level"].name == "INFO" else CONSOLE_FORMAT_FULL,
+    format = lambda record: LOG_CONSOLE_FORMAT_SIMPLE if record["level"].name == "INFO" else LOG_CONSOLE_FORMAT_FULL,
     colorize = True
 )
 
-def setup_logger(log_level: str):
+def setup_logger(log_level: str, log_dir: str):
     """Configure logger with specified level and outputs"""
     
-    logger.remove()
-    
-    log_dir = Path("app/logs")
+    log_dir = Path(log_dir)
     log_dir.mkdir(exist_ok=True, parents=True)
     
+    logger.remove()
+    
     # File handler
     logger.add(
-        sink = log_dir / "app.log",
+        sink = log_dir / "{time:YYYYMMDD-HHmmss!UTC}Z.log",
         level = log_level,
-        rotation = "500 MB",
-        format = FILE_FORMAT,
+        rotation = "100 MB",
+        retention = 0,
+        format = LOG_FILE_FORMAT,
         serialize = False,
         enqueue = True,
         backtrace = True,
@@ -42,7 +43,7 @@ def setup_logger(log_level: str):
     logger.add(
         sink = sys.stderr,
         level = log_level,
-        format = lambda record: CONSOLE_FORMAT_SIMPLE if record["level"].name == "INFO" else CONSOLE_FORMAT_FULL,
+        format = lambda record: LOG_CONSOLE_FORMAT_SIMPLE if record["level"].name == "INFO" else LOG_CONSOLE_FORMAT_FULL,
         colorize = True
     )
 
@@ -133,10 +134,10 @@ top_parser.add_argument(
 )
 
 top_parser.add_argument(
-    '--log-path',
-    envvar = 'LOG_PATH',
-    help = 'Path to log file',
-    default = '.logs',
+    '--log-dir',
+    envvar = 'LOG_DIR',
+    help = 'Path to log directory',
+    default = '.pirag/logs',
     type = str,
     required = False,
     action = EnvDefault,

app/rag/doctor/__init__.py

@@ -0,0 +1,2 @@
+from .config import parser, help
+from .router import route

app/rag/doctor/config.py

@@ -0,0 +1,24 @@
+import argparse
+
+from app.rag.config import top_parser, common_parser
+
+help = "Diagnose the RAG system."
+
+parser = argparse.ArgumentParser(
+    description = f"{help} Performs comprehensive health checks on all components, validates configurations, and reports issues to ensure optimal system operation",
+    add_help = False,
+    formatter_class = argparse.ArgumentDefaultsHelpFormatter,
+)
+
+subparsers = parser.add_subparsers(
+    title = "subcommands",
+    dest = "subcommand",
+)
+
+subparsers.add_parser(
+    "check",
+    help = "Check RAG System. Scan all components of the system and diagnose status",
+    description = "Check RAG System. Scan all components of the system and diagnose status",
+    parents = [top_parser, common_parser],
+    add_help = False,
+)

app/rag/doctor/router.py

@@ -0,0 +1,7 @@
+from argparse import Namespace
+from loguru import logger
+
+def route(args: Namespace):
+    logger.info("Doctor route")
+    print(args)
+

app/rag/test/__init__.py

@@ -0,0 +1,2 @@
+from .config import parser, help
+from .router import route

app/rag/test/config.py

@@ -0,0 +1,9 @@
+import argparse
+
+help = "Test the RAG system."
+
+parser = argparse.ArgumentParser(
+    description = f"{help} Evaluates system performance by running predefined test cases, measuring accuracy, relevance, and latency metrics to validate retrieval and generation capabilities",
+    add_help = False,
+    formatter_class = argparse.ArgumentDefaultsHelpFormatter,
+)

app/rag/test/router.py

@@ -0,0 +1,15 @@
+from argparse import Namespace
+from ragas import evaluate
+from ragas.metrics import (
+    answer_relevancy,
+    faithfulness,
+    context_precision,
+    context_recall,
+)
+
+def route(args: Namespace):
+    
+    result = evaluate(
+        
+    )
+    print(args)

app/rag/test/service.py

@@ -0,0 +1,9 @@
+# https://milvus.io/docs/integrate_with_ragas.md
+from ragas.metrics import (
+    answer_relevancy,
+    faithfulness,
+    context_precision,
+    context_recall,
+)
+
+

app/rag/train/__init__.py

@@ -0,0 +1,2 @@
+from .config import parser, help
+from .router import route

app/rag/train/config.py

@@ -0,0 +1,20 @@
+import argparse
+
+help = "Train the RAG system."
+
+parser = argparse.ArgumentParser(
+    description = f"{help} Processes documents, extracts knowledge, generates embeddings, and builds a searchable vector database for efficient semantic retrieval and contextual responses",
+    add_help = False,
+    formatter_class = argparse.ArgumentDefaultsHelpFormatter,
+)
+
+subparsers = parser.add_subparsers(
+    title = "subcommands",
+    dest = "subcommand",
+)
+
+subparsers.add_parser(
+    "check",
+    help = "Check RAG System. Scan all components of the system and diagnose status",
+    description = "Check RAG System. Scan all components of the system and diagnose status",
+)

app/rag/train/router.py

@@ -0,0 +1,4 @@
+from argparse import Namespace
+
+def route(args: Namespace):
+    print(args)

app/setup.py

@@ -16,8 +16,7 @@ APP_NAME = "pirag"
 setup(
     name = APP_NAME,
     version = version,
-    packages = [".", "rag"],
-    package_dir = {"": ".", "rag": "rag"},
+    packages = find_packages(),
     include_package_data = True,
     install_requires = requirements,
     entry_points = {

{pirag-0.1.0.dist-info → pirag-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pirag
-Version: 0.1.0
+Version: 0.1.2
 Summary: CLI Projects of On-Premise RAG. You can use your own LLM and vector DB. Or just add remote LLM servers and vector DB.
 Author-email: semir4in <semir4in@gmail.com>, jyje <jyjeon@outlook.com>
 Project-URL: Homepage, https://github.com/jyje/pilot-onpremise-rag
@@ -46,15 +46,20 @@ Dynamic: license-file
 git clone https://github.com/jyje/pilot-onpremise-rag
 cd pilot-onpremise-rag
 
-docker compose -f docker/compose.yaml up -d
+docker compose -f docker/compose.yaml up
 ```
 
-### Install pirag
+### Install pirag from source
 ```bash
 git clone https://github.com/jyje/pilot-onpremise-rag
 cd pilot-onpremise-rag
 
-pip install --upgrade -e ./app
+pip install --upgrade -e .
+```
+
+### Install pirag from PyPI
+```bash
+pip install --upgrade pirag
 ```
 
 ## 📚 Usage

pirag-0.1.2.dist-info/RECORD

@@ -0,0 +1,27 @@
+app/main.py,sha256=Zl9yGtnZqTH8-0ljdvsvvQ_7Nksv8_1wo-oZntmhbos,2241
+app/requirements.txt,sha256=JFEWoQHN7hwDg0bDrWlN0vxZVR3oe8dYgv7mkHrQg1g,128
+app/setup.py,sha256=j9qcfapv_jOW3jORYGfHzKDAcxNRItHcHA34_mMDGj4,744
+app/rag/agent.py,sha256=u1ovyqALsmOMHDCW-hdlkMU72XdlTMiFJ-WRbLHHrYQ,2190
+app/rag/config.py,sha256=KVDuJ8wVwgb9akMSxEl8cTJ3p7UHECZHlXKiyRopj10,5172
+app/rag/ask/__init__.py,sha256=41lK4nmvWT2ZZ3G_FMtOiG-0JFJdDVT4zoxkoes8TaE,59
+app/rag/ask/config.py,sha256=tRHOBrEAmTMBaBmYPKPsRJmSaVyKT8-TBSDJQXEndxc,386
+app/rag/ask/router.py,sha256=5nuaaHzWVr2ltYqOuQ30ujmZ-GFyx-22OLVODILd5iE,76
+app/rag/ask/service.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+app/rag/doctor/__init__.py,sha256=41lK4nmvWT2ZZ3G_FMtOiG-0JFJdDVT4zoxkoes8TaE,59
+app/rag/doctor/config.py,sha256=CW0scwLkRykKLp15szu6Q9i3sG7n70ZJ0eYOtkjuS9Q,765
+app/rag/doctor/router.py,sha256=ZP2q_aHaVz5kTjBPLX9Oc3NdLe8MdIqjRReHGBLgoW8,135
+app/rag/doctor/service.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+app/rag/test/__init__.py,sha256=41lK4nmvWT2ZZ3G_FMtOiG-0JFJdDVT4zoxkoes8TaE,59
+app/rag/test/config.py,sha256=tk-IM1VspaUPgwWKSwYWagkdYXfOjIAjU3-c0rxMBoc,361
+app/rag/test/router.py,sha256=zfqLhfYwP3nvoZEJWtxGwKuYdEk7NmM83EYlL5wVy8w,259
+app/rag/test/service.py,sha256=Znb-qEM5eM6-Y-tmSoBklsLGR6gEKeYqc1EW_yzYts0,164
+app/rag/train/__init__.py,sha256=41lK4nmvWT2ZZ3G_FMtOiG-0JFJdDVT4zoxkoes8TaE,59
+app/rag/train/config.py,sha256=PO4iRMmZXViFHOMBbOOhnFHqBu8hRfbI61zGCuksKhI,668
+app/rag/train/router.py,sha256=5nuaaHzWVr2ltYqOuQ30ujmZ-GFyx-22OLVODILd5iE,76
+app/rag/train/service.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pirag-0.1.2.dist-info/licenses/LICENSE,sha256=gBUmwRyDQYI4Q4Ju5S88urvB-B-nqsXN45n8oQ3DZ3Y,1079
+pirag-0.1.2.dist-info/METADATA,sha256=Tbr20PW_FnjRcRXK1u3gDl-uVeunQtQGMlQM9tP5m10,5232
+pirag-0.1.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+pirag-0.1.2.dist-info/entry_points.txt,sha256=1tHs5rP66AVq5SMEWRRIWRf_XqJo2Gb1TJl9-Kw_MSo,40
+pirag-0.1.2.dist-info/top_level.txt,sha256=io9g7LCbfmTG1SFKgEOGXmCFB9uMP2H5lerm0HiHWQE,4
+pirag-0.1.2.dist-info/RECORD,,

pirag-0.1.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-app/main.py,sha256=CRpnMBACO2446xoGbgN6mz9QH2_EM-Ibi017x3WoJiE,2182
-app/requirements.txt,sha256=JFEWoQHN7hwDg0bDrWlN0vxZVR3oe8dYgv7mkHrQg1g,128
-app/setup.py,sha256=Ku79YGHGZL6N7m4mOtXq96y8jrhzf4R5OPGu0fHCRq8,784
-app/rag/agent.py,sha256=u1ovyqALsmOMHDCW-hdlkMU72XdlTMiFJ-WRbLHHrYQ,2190
-app/rag/config.py,sha256=SNVJF7zEuClG818W9Ot_ecOqVdy2390hzxe73hD0jzg,5057
-pirag-0.1.0.dist-info/licenses/LICENSE,sha256=gBUmwRyDQYI4Q4Ju5S88urvB-B-nqsXN45n8oQ3DZ3Y,1079
-pirag-0.1.0.dist-info/METADATA,sha256=uqWodH_r0zaoiEhLuuq-7ga86qYa_vjJbTB09jPa7T0,5158
-pirag-0.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-pirag-0.1.0.dist-info/entry_points.txt,sha256=1tHs5rP66AVq5SMEWRRIWRf_XqJo2Gb1TJl9-Kw_MSo,40
-pirag-0.1.0.dist-info/top_level.txt,sha256=io9g7LCbfmTG1SFKgEOGXmCFB9uMP2H5lerm0HiHWQE,4
-pirag-0.1.0.dist-info/RECORD,,