ragbits-cli 0.3.0__tar.gz → 0.5.0__tar.gz

{ragbits_cli-0.3.0 → ragbits_cli-0.5.0}/.gitignore

@@ -95,5 +95,6 @@ dist/
 
 # examples
 chroma/
+qdrant/
 
 .aider*

{ragbits_cli-0.3.0 → ragbits_cli-0.5.0}/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## Unreleased
 
+## 0.5.0 (2024-12-05)
+
+### Added
+
+- Add global flag to specify output type: text or json (#232).
+
+### Changed
+
+- ragbits-core updated to version v0.5.0
+
+## 0.4.0 (2024-11-27)
+
+### Changed
+
+- ragbits-core updated to version v0.4.0
+
 ## 0.3.0 (2024-11-06)
 
 ### Changed

{ragbits_cli-0.3.0 → ragbits_cli-0.5.0}/PKG-INFO

@@ -1,9 +1,13 @@
 Metadata-Version: 2.3
 Name: ragbits-cli
-Version: 0.3.0
+Version: 0.5.0
 Summary: A CLI application for ragbits - building blocks for rapid development of GenAI applications
+Project-URL: Homepage, https://github.com/deepsense-ai/ragbits
+Project-URL: Bug Reports, https://github.com/deepsense-ai/ragbits/issues
+Project-URL: Documentation, https://ragbits.deepsense.ai/
+Project-URL: Source, https://github.com/deepsense-ai/ragbits
 Author-email: "deepsense.ai" <ragbits@deepsense.ai>
-License-Expression: MIT
+License: MIT
 Keywords: GenAI,Generative AI,LLMs,Large Language Models,Prompt Management,RAG,Retrieval Augmented Generation
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
@@ -18,7 +22,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
-Requires-Dist: ragbits-core==0.3.0
+Requires-Dist: ragbits-core==0.5.0
 Requires-Dist: typer>=0.12.5
 Description-Content-Type: text/markdown
 

{ragbits_cli-0.3.0 → ragbits_cli-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ragbits-cli"
-version = "0.3.0"
+version = "0.5.0"
 description = "A CLI application for ragbits - building blocks for rapid development of GenAI applications"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -31,7 +31,13 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Artificial Intelligence",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-dependencies = ["typer>=0.12.5", "ragbits-core==0.3.0"]
+dependencies = ["typer>=0.12.5", "ragbits-core==0.5.0"]
+
+[project.urls]
+"Homepage" = "https://github.com/deepsense-ai/ragbits"
+"Bug Reports" = "https://github.com/deepsense-ai/ragbits/issues"
+"Documentation" = "https://ragbits.deepsense.ai/"
+"Source" = "https://github.com/deepsense-ai/ragbits"
 
 [project.scripts]
 ragbits = "ragbits.cli:main"

{ragbits_cli-0.3.0 → ragbits_cli-0.5.0}/src/ragbits/cli/__init__.py

@@ -1,12 +1,29 @@
 import importlib.util
 import pkgutil
 from pathlib import Path
+from typing import Annotated
 
-from typer import Typer
+import typer
 
 import ragbits
 
-app = Typer(no_args_is_help=True)
+from .app import CLI, OutputType
+
+app = CLI(no_args_is_help=True)
+
+
+@app.callback()
+def output_type(
+    # `OutputType.text.value` used as a workaround for the issue with `typer.Option` not accepting Enum values
+    output: Annotated[
+        OutputType, typer.Option("--output", "-o", help="Set the output type (text or json)")
+    ] = OutputType.text.value,  # type: ignore
+) -> None:
+    """Sets an output type for the CLI
+    Args:
+        output: type of output to be set
+    """
+    app.set_output_type(output_type=output)
 
 
 def main() -> None:

ragbits_cli-0.5.0/src/ragbits/cli/app.py

@@ -0,0 +1,76 @@
+import json
+from dataclasses import dataclass
+from enum import Enum
+from typing import Any
+
+import typer
+from pydantic import BaseModel
+from rich.console import Console
+from rich.table import Table
+
+
+class OutputType(Enum):
+    """Indicates a type of CLI output formatting"""
+
+    text = "text"
+    json = "json"
+
+
+@dataclass()
+class CliState:
+    """A dataclass describing CLI state"""
+
+    output_type: OutputType = OutputType.text
+
+
+class CLI(typer.Typer):
+    """A CLI class with output formatting"""
+
+    def __init__(self, *args: Any, **kwargs: Any):  # noqa: ANN401
+        super().__init__(*args, **kwargs)
+        self.state: CliState = CliState()
+        self.console: Console = Console()
+
+    def set_output_type(self, output_type: OutputType) -> None:
+        """
+        Set the output type in the app state
+        Args:
+            output_type: OutputType
+        """
+        self.state.output_type = output_type
+
+    def print_output(self, data: list[BaseModel] | BaseModel) -> None:
+        """
+        Process and display output based on the current state's output type.
+
+        Args:
+            data: list of ditionaries or list of pydantic models representing output of CLI function
+        """
+        if isinstance(data, BaseModel):
+            data = [data]
+        if len(data) == 0:
+            self._print_empty_list()
+            return
+        first_el_instance = type(data[0])
+        if any(not isinstance(datapoint, first_el_instance) for datapoint in data):
+            raise ValueError("All the rows need to be of the same type")
+        data_dicts: list[dict] = [output.model_dump(mode="python") for output in data]
+        output_type = self.state.output_type
+        if output_type == OutputType.json:
+            print(json.dumps(data_dicts, indent=4))
+        elif output_type == OutputType.text:
+            table = Table(show_header=True, header_style="bold magenta")
+            properties = data[0].model_json_schema()["properties"]
+            for key in properties:
+                table.add_column(properties[key]["title"])
+            for row in data_dicts:
+                table.add_row(*[str(value) for value in row.values()])
+            self.console.print(table)
+        else:
+            raise ValueError(f"Output type: {output_type} not supported")
+
+    def _print_empty_list(self) -> None:
+        if self.state.output_type == OutputType.text:
+            print("Empty data list")
+        elif self.state.output_type == OutputType.json:
+            print(json.dumps([]))