pirag 0.1.0__tar.gz → 0.1.2__tar.gz

{pirag-0.1.0 → pirag-0.1.2}/PKG-INFO

@@ -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.0 → pirag-0.1.2}/README.md

@@ -27,15 +27,20 @@
 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.0 → pirag-0.1.2}/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':

pirag-0.1.2/app/rag/ask/__init__.py

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

pirag-0.1.2/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,
+)

pirag-0.1.2/app/rag/ask/router.py

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

{pirag-0.1.0 → pirag-0.1.2}/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,

pirag-0.1.2/app/rag/doctor/__init__.py

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

pirag-0.1.2/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,
+)

pirag-0.1.2/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)
+

pirag-0.1.2/app/rag/test/__init__.py

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

pirag-0.1.2/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,
+)

pirag-0.1.2/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)

pirag-0.1.2/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,
+)
+
+

pirag-0.1.2/app/rag/train/__init__.py

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

pirag-0.1.2/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",
+)

pirag-0.1.2/app/rag/train/router.py

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

{pirag-0.1.0 → pirag-0.1.2}/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 → pirag-0.1.2}/pirag.egg-info/PKG-INFO

@@ -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/pirag.egg-info/SOURCES.txt

@@ -0,0 +1,30 @@
+LICENSE
+README.md
+pyproject.toml
+app/main.py
+app/requirements.txt
+app/setup.py
+app/rag/agent.py
+app/rag/config.py
+app/rag/ask/__init__.py
+app/rag/ask/config.py
+app/rag/ask/router.py
+app/rag/ask/service.py
+app/rag/doctor/__init__.py
+app/rag/doctor/config.py
+app/rag/doctor/router.py
+app/rag/doctor/service.py
+app/rag/test/__init__.py
+app/rag/test/config.py
+app/rag/test/router.py
+app/rag/test/service.py
+app/rag/train/__init__.py
+app/rag/train/config.py
+app/rag/train/router.py
+app/rag/train/service.py
+pirag.egg-info/PKG-INFO
+pirag.egg-info/SOURCES.txt
+pirag.egg-info/dependency_links.txt
+pirag.egg-info/entry_points.txt
+pirag.egg-info/requires.txt
+pirag.egg-info/top_level.txt

pirag-0.1.2/pirag.egg-info/top_level.txt

@@ -0,0 +1,4 @@
+app
+assets
+dist
+docker

{pirag-0.1.0 → pirag-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pirag"
-version = "0.1.0"
+version = "0.1.2"
 description = "CLI Projects of On-Premise RAG. You can use your own LLM and vector DB. Or just add remote LLM servers and vector DB."
 authors = [
     { name="semir4in", email="semir4in@gmail.com" },
@@ -29,11 +29,8 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools]
-packages = ["app", "app.rag"]
-
-[tool.setuptools.package-dir]
-app = "app"
-"app.rag" = "app/rag"
+packages = {find = {namespaces = true}}
+include-package-data = true
 
 [tool.setuptools.dynamic]
 dependencies = {file = ["app/requirements.txt"]}

pirag-0.1.0/pirag.egg-info/SOURCES.txt

@@ -1,14 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-app/main.py
-app/requirements.txt
-app/setup.py
-app/rag/agent.py
-app/rag/config.py
-pirag.egg-info/PKG-INFO
-pirag.egg-info/SOURCES.txt
-pirag.egg-info/dependency_links.txt
-pirag.egg-info/entry_points.txt
-pirag.egg-info/requires.txt
-pirag.egg-info/top_level.txt

pirag-0.1.0/pirag.egg-info/top_level.txt

@@ -1 +0,0 @@
-app