ragbits-cli 0.7.0__tar.gz → 0.9.0__tar.gz

{ragbits_cli-0.7.0 → ragbits_cli-0.9.0}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Unreleased
 
+## 0.9.0 (2025-02-25)
+
+### Changed
+
+- ragbits-core updated to version v0.9.0
+
+## 0.8.0 (2025-01-29)
+
+### Changed
+
+- ragbits-core updated to version v0.8.0
+
 ## 0.7.0 (2025-01-21)
 
 ### Changed

ragbits_cli-0.9.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: ragbits-cli
+Version: 0.9.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
+Keywords: GenAI,Generative AI,LLMs,Large Language Models,Prompt Management,RAG,Retrieval Augmented Generation
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+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-Python: >=3.10
+Requires-Dist: ragbits-core==0.9.0
+Requires-Dist: typer>=0.12.5
+Description-Content-Type: text/markdown
+
+# Ragbits CLI
+
+Ragbits CLI provides the `ragbits` command-line interface (CLI) tool that allows you to interact with Ragbits from the terminal. Other packages can extend the CLI by adding their own commands, so the exact set of available commands may vary depending on the installed packages.
+
+## Installation
+
+To use the complete Ragbits stack, install the `ragbits` package:
+
+```sh
+pip install ragbits
+```
+
+## Example Usage
+The following example assumes that `ragbits-core` is installed and that the current ddirectory contains a `song_prompt.py` file with a prompt class named `SongPrompt`, as defined in the [Quickstart Guide](https://ragbits.deepsense.ai/quickstart/quickstart1_prompts/#making-the-prompt-dynamic).
+
+The example demonstrates how to execute the prompt using the `ragbits` CLI tool.
+The left side of the table shows the system and user prompts (rendered with placeholders replaced by the provided values), and the right side shows the generated response from the Large Language Model.
+
+```sh
+$ ragbits prompts exec song_prompt:SongPrompt --payload '{"subject": "unicorns", "age_group": 12, "genre": "pop"}'
+
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Question                              ┃ Answer                                ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ [{'role': 'system', 'content': 'You   │ (Verse 1)                             │
+│ are a professional songwriter.        │ In a land of rainbows and glitter,    │
+│ You only use language that is         │ Where flowers bloom and skies are     │
+│ appropriate for children.'},          │ brighter,                             │
+│ {'role': 'user', 'content': 'Write a  │ There's a magical creature so rare,   │
+│ song about a unicorns for 12 years    │ With a horn that sparkles in the air. │
+│ old pop fans.'}]                      │                                       │
+│                                       │ (Chorus)                              │
+│                                       │ Unicorns, unicorns, oh so divine,     │
+│                                       │ With their mane that shines and eyes  │
+│                                       │ that shine,                           │
+│                                       │ Gallop through the meadows, so free,  │
+│                                       │ In a world of wonder, just you and    │
+│                                       │ me.                                   │
+└───────────────────────────────────────┴───────────────────────────────────────┘
+```
+
+## Documentation
+* [Documentation of the `ragbits` CLI](https://ragbits.deepsense.ai/cli/main/)

ragbits_cli-0.9.0/README.md

@@ -0,0 +1,43 @@
+# Ragbits CLI
+
+Ragbits CLI provides the `ragbits` command-line interface (CLI) tool that allows you to interact with Ragbits from the terminal. Other packages can extend the CLI by adding their own commands, so the exact set of available commands may vary depending on the installed packages.
+
+## Installation
+
+To use the complete Ragbits stack, install the `ragbits` package:
+
+```sh
+pip install ragbits
+```
+
+## Example Usage
+The following example assumes that `ragbits-core` is installed and that the current ddirectory contains a `song_prompt.py` file with a prompt class named `SongPrompt`, as defined in the [Quickstart Guide](https://ragbits.deepsense.ai/quickstart/quickstart1_prompts/#making-the-prompt-dynamic).
+
+The example demonstrates how to execute the prompt using the `ragbits` CLI tool.
+The left side of the table shows the system and user prompts (rendered with placeholders replaced by the provided values), and the right side shows the generated response from the Large Language Model.
+
+```sh
+$ ragbits prompts exec song_prompt:SongPrompt --payload '{"subject": "unicorns", "age_group": 12, "genre": "pop"}'
+
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Question                              ┃ Answer                                ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ [{'role': 'system', 'content': 'You   │ (Verse 1)                             │
+│ are a professional songwriter.        │ In a land of rainbows and glitter,    │
+│ You only use language that is         │ Where flowers bloom and skies are     │
+│ appropriate for children.'},          │ brighter,                             │
+│ {'role': 'user', 'content': 'Write a  │ There's a magical creature so rare,   │
+│ song about a unicorns for 12 years    │ With a horn that sparkles in the air. │
+│ old pop fans.'}]                      │                                       │
+│                                       │ (Chorus)                              │
+│                                       │ Unicorns, unicorns, oh so divine,     │
+│                                       │ With their mane that shines and eyes  │
+│                                       │ that shine,                           │
+│                                       │ Gallop through the meadows, so free,  │
+│                                       │ In a world of wonder, just you and    │
+│                                       │ me.                                   │
+└───────────────────────────────────────┴───────────────────────────────────────┘
+```
+
+## Documentation
+* [Documentation of the `ragbits` CLI](https://ragbits.deepsense.ai/cli/main/)

{ragbits_cli-0.7.0 → ragbits_cli-0.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ragbits-cli"
-version = "0.7.0"
+version = "0.9.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,7 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Artificial Intelligence",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-dependencies = ["typer>=0.12.5", "ragbits-core==0.7.0"]
+dependencies = ["typer>=0.12.5", "ragbits-core==0.9.0"]
 
 [project.urls]
 "Homepage" = "https://github.com/deepsense-ai/ragbits"

{ragbits_cli-0.7.0 → ragbits_cli-0.9.0}/src/ragbits/cli/_utils.py

@@ -6,7 +6,7 @@ from pydantic.alias_generators import to_snake
 from rich.console import Console
 
 from ragbits.core.config import CoreConfig, core_config
-from ragbits.core.utils.config_handling import InvalidConfigError, NoDefaultConfigError, WithConstructionConfig
+from ragbits.core.utils.config_handling import InvalidConfigError, NoPreferredConfigError, WithConstructionConfig
 
 WithConstructionConfigT_co = TypeVar("WithConstructionConfigT_co", bound=WithConstructionConfig, covariant=True)
 
@@ -16,8 +16,8 @@ WithConstructionConfigT_co = TypeVar("WithConstructionConfigT_co", bound=WithCon
 # to be used as types: https://github.com/python/mypy/issues/4717
 class WithConstructionConfigProtocol(Protocol[WithConstructionConfigT_co]):
     @classmethod
-    def subclass_from_defaults(
-        cls, defaults: CoreConfig, factory_path_override: str | None = None, yaml_path_override: Path | None = None
+    def preferred_subclass(
+        cls, config: CoreConfig, factory_path_override: str | None = None, yaml_path_override: Path | None = None
     ) -> WithConstructionConfigT_co: ...
 
 
@@ -26,11 +26,12 @@ def get_instance_or_exit(
     type_name: str | None = None,
     yaml_path: Path | None = None,
     factory_path: str | None = None,
+    config_override: CoreConfig | None = None,
     yaml_path_argument_name: str = "--yaml-path",
     factory_path_argument_name: str = "--factory-path",
 ) -> WithConstructionConfigT_co:
     """
-    Returns an instance of the provided class, initialized using its `subclass_from_defaults` method.
+    Returns an instance of the provided class, initialized using its `preferred_subclass` method.
     If the instance can't be created, prints an error message and exits the program.
 
     Args:
@@ -39,6 +40,7 @@ def get_instance_or_exit(
         yaml_path: Path to a YAML configuration file to use for initialization.
         factory_path: Python path to a factory function to use for initialization.
         yaml_path_argument_name: The name of the argument to use in error messages for the YAML path.
+        config_override: A config instance to be used
         factory_path_argument_name: The name of the argument to use in error messages for the factory path.
     """
     if not isinstance(cls, type):
@@ -46,18 +48,19 @@ def get_instance_or_exit(
 
     type_name = type_name or to_snake(cls.__name__).replace("_", " ")
     try:
-        return cls.subclass_from_defaults(
-            core_config,
+        return cls.preferred_subclass(
+            config_override or core_config,
             factory_path_override=factory_path,
             yaml_path_override=yaml_path,
         )
-    except NoDefaultConfigError as e:
+    except NoPreferredConfigError as e:
         Console(
             stderr=True
         ).print(f"""You need to provide the [b]{type_name}[/b] instance to be used. You can do this by either:
 - providing a path to a YAML configuration file with the [b]{yaml_path_argument_name}[/b] option
 - providing a Python path to a function that creates a vector store with the [b]{factory_path_argument_name}[/b] option
-- setting the default configuration or factory function in your project's [b]pyproject.toml[/b] file""")
+- setting the preferred {type_name} configuration in your project's [b]pyproject.toml[/b] file
+  (see https://ragbits.deepsense.ai/how-to/core/component_preferrences/ for more information)""")
         raise typer.Exit(1) from e
     except InvalidConfigError as e:
         Console(stderr=True).print(e)

{ragbits_cli-0.7.0 → ragbits_cli-0.9.0}/src/ragbits/cli/state.py

@@ -2,10 +2,12 @@ import json
 from collections.abc import Mapping, Sequence
 from dataclasses import dataclass
 from enum import Enum
-from typing import TypeVar
+from types import UnionType
+from typing import Optional, TypeVar, Union, get_args, get_origin
 
 import typer
 from pydantic import BaseModel
+from pydantic.fields import FieldInfo
 from rich.console import Console
 from rich.table import Column, Table
 
@@ -48,39 +50,72 @@ def print_output_table(
         console.print("No results")
         return
 
-    fields = {**data[0].model_fields, **data[0].model_computed_fields}
-
-    # Human readable titles for columns
-    titles = {
-        key: value.get("title", key)
-        for key, value in data[0].model_json_schema(mode="serialization")["properties"].items()
-    }
+    base_fields = {**data[0].model_fields, **data[0].model_computed_fields}
 
     # Normalize the list of columns
     if columns is None:
-        columns = {key: Column() for key in fields}
+        columns = {key: Column() for key in base_fields}
     elif isinstance(columns, str):
         columns = {key: Column() for key in columns.split(",")}
     elif isinstance(columns, Sequence):
         columns = {key: Column() for key in columns}
 
-    # Add headers to columns if not provided
-    for key in columns:
-        if key not in fields:
-            Console(stderr=True).print(f"Unknown column: {key}")
-            raise typer.Exit(1)
-
-        column = columns[key]
+    # check if columns are correct
+    for column_name in columns:
+        field = _get_nested_field(column_name, base_fields)
+        column = columns[column_name]
         if column.header == "":
-            column.header = titles.get(key, key)
+            column.header = field.title if field.title else column_name.replace("_", " ").replace(".", " ").title()
 
     # Create and print the table
     table = Table(*columns.values(), show_header=True, header_style="bold magenta")
+
     for row in data:
-        table.add_row(*[str(getattr(row, key)) for key in columns])
+        row_to_add = []
+        for key in columns:
+            *path_fragments, field_name = key.strip().split(".")
+            base_row = row
+            for fragment in path_fragments:
+                base_row = getattr(base_row, fragment)
+            z = getattr(base_row, field_name)
+            row_to_add.append(str(z))
+        table.add_row(*row_to_add)
+
     console.print(table)
 
 
+def _get_nested_field(column_name: str, base_fields: dict) -> FieldInfo:
+    """
+    Check if column name exists in the model schema.
+
+    Args:
+        column_name: name of the column to check
+        base_fields: model fields
+    Returns:
+        field: nested field
+    """
+    fields = base_fields
+    *path_fragments, field_name = column_name.strip().split(".")
+    for fragment in path_fragments:
+        if fragment not in fields:
+            Console(stderr=True).print(
+                f"Unknown column: {'.'.join(path_fragments + [field_name])} ({fragment} not found)"
+            )
+            raise typer.Exit(1)
+        model_class = fields[fragment].annotation
+        if get_origin(model_class) in [UnionType, Optional, Union]:
+            types = get_args(model_class)
+            model_class = next((t for t in types if t is not type(None)), None)
+        if model_class and issubclass(model_class, BaseModel):
+            fields = {**model_class.model_fields, **model_class.model_computed_fields}
+    if field_name not in fields:
+        Console(stderr=True).print(
+            f"Unknown column: {'.'.join(path_fragments + [field_name])} ({field_name} not found)"
+        )
+        raise typer.Exit(1)
+    return fields[field_name]
+
+
 def print_output_json(data: Sequence[ModelT]) -> None:
     """
     Display data from Pydantic models in a JSON format.

ragbits_cli-0.9.0/tests/unit/test_state.py

@@ -0,0 +1,121 @@
+from pathlib import Path
+from unittest.mock import MagicMock, patch
+
+import pytest
+import typer
+from pydantic import BaseModel
+from pydantic.fields import Field, FieldInfo
+from rich.table import Column, Table
+
+from ragbits.cli.state import OutputType, _get_nested_field, print_output, print_output_table
+from ragbits.document_search.documents.sources import LocalFileSource
+
+
+class InnerTestModel(BaseModel):
+    id: int
+    name: str = Field(title="Name of the inner model", description="Name of the inner model")
+    location: LocalFileSource
+
+
+class OtherTestModel(BaseModel):
+    id: int
+    name: str
+    location: InnerTestModel
+
+
+class MainTestModel(BaseModel):
+    id: int
+    name: str
+    model: OtherTestModel | None
+
+
+data = [
+    MainTestModel(
+        id=1,
+        name="A",
+        model=OtherTestModel(
+            id=11,
+            name="aa",
+            location=InnerTestModel(id=111, name="aa1", location=LocalFileSource(path=Path("folder_1"))),
+        ),
+    ),
+    MainTestModel(
+        id=2,
+        name="B",
+        model=OtherTestModel(
+            id=22,
+            name="bb",
+            location=InnerTestModel(id=222, name="aa2", location=LocalFileSource(path=Path("folder_2"))),
+        ),
+    ),
+]
+
+
+@patch("ragbits.cli.state.print_output_table")
+@patch("ragbits.cli.state.print_output_json")
+def test_print_output_text(mock_print_output_json: MagicMock, mock_print_output_table: MagicMock):
+    with patch("ragbits.cli.state.cli_state") as mock_cli_state:
+        mock_cli_state.output_type = OutputType.text
+        columns = {"id": Column(), "name": Column()}
+        print_output(data, columns=columns)
+        mock_print_output_table.assert_called_once_with(data, columns)
+        mock_print_output_json.assert_not_called()
+
+
+@patch("ragbits.cli.state.print_output_table")
+@patch("ragbits.cli.state.print_output_json")
+def test_print_output_json(mock_print_output_json: MagicMock, mock_print_output_table: MagicMock):
+    with patch("ragbits.cli.state.cli_state") as mock_cli_state:
+        mock_cli_state.output_type = OutputType.json
+        print_output(data)
+        mock_print_output_table.assert_not_called()
+        mock_print_output_json.assert_called_once_with(data)
+
+
+def test_print_output_unsupported_output_type():
+    with patch("ragbits.cli.state.cli_state") as mock_cli_state:
+        mock_cli_state.output_type = "unsupported_type"
+        with pytest.raises(ValueError, match="Unsupported output type: unsupported_type"):
+            print_output(data)
+
+
+def test_print_output_table():
+    with patch("rich.console.Console.print") as mock_print:
+        columns = {"id": Column(), "model.location.location.path": Column(), "model.location.name": Column()}
+        print_output_table(data, columns)
+        mock_print.assert_called_once()
+        args, _ = mock_print.call_args_list[0]
+        printed_table = args[0]
+        assert isinstance(printed_table, Table)
+        assert printed_table.columns[0].header == "Id"
+        assert printed_table.columns[1].header == "Model Location Location Path"
+        assert printed_table.columns[2].header == "Name of the inner model"
+        assert printed_table.row_count == 2
+
+
+def test_get_nested_field():
+    column = "model.location.location.path"
+    fields = {"name": FieldInfo(annotation=str), "model": FieldInfo(annotation=OtherTestModel)}
+
+    try:
+        result = _get_nested_field(column, fields)
+        assert result.annotation == Path
+    except typer.Exit:
+        pytest.fail("typer.Exit was raised unexpectedly")
+
+
+def test_get_nested_field_wrong_field():
+    column_names = [
+        ("model.location.wrong_field", "wrong_field"),
+        ("model.wrong_path.location.path", "wrong_path"),
+        ("wrong_path.location.location.path", "wrong_path"),
+        ("model.location.path", "path"),
+        ("model.location.location.path.additional_field", "additional_field"),
+    ]
+    fields = {"name": FieldInfo(annotation=str), "model": FieldInfo(annotation=OtherTestModel)}
+
+    for wrong_column, wrong_fragment in column_names:
+        with patch("rich.console.Console.print") as mock_print:
+            with pytest.raises(typer.Exit, match="1"):
+                _get_nested_field(wrong_column, fields)
+            mock_print.assert_called_once_with(f"Unknown column: {wrong_column} ({wrong_fragment} not found)")

ragbits_cli-0.7.0/PKG-INFO

@@ -1,29 +0,0 @@
-Metadata-Version: 2.4
-Name: ragbits-cli
-Version: 0.7.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
-Keywords: GenAI,Generative AI,LLMs,Large Language Models,Prompt Management,RAG,Retrieval Augmented Generation
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-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-Python: >=3.10
-Requires-Dist: ragbits-core==0.7.0
-Requires-Dist: typer>=0.12.5
-Description-Content-Type: text/markdown
-
-# Ragbits CLI

ragbits_cli-0.7.0/README.md

@@ -1 +0,0 @@
-# Ragbits CLI