hammad-python 0.0.19__tar.gz → 0.0.21__tar.gz

{hammad_python-0.0.19 → hammad_python-0.0.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hammad-python
-Version: 0.0.19
+Version: 0.0.21
 Author-email: Hammad Saeed <hammadaidev@gmail.com>
 License: MIT License
         
@@ -28,12 +28,13 @@ Requires-Python: >=3.11
 Requires-Dist: ddgs>=9.0.0
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: msgspec>=0.19.0
+Requires-Dist: nest-asyncio>=1.6.0
 Requires-Dist: pydantic>=2.11.7
 Requires-Dist: rich>=14.0.0
 Requires-Dist: selectolax>=0.3.31
 Requires-Dist: sqlalchemy>=2.0.41
 Requires-Dist: tantivy>=0.24.0
-Requires-Dist: tenacity>=9.1.2
+Requires-Dist: tenacity>=8.2.3
 Requires-Dist: typing-inspect>=0.9.0
 Provides-Extra: ai
 Requires-Dist: instructor>=1.9.0; extra == 'ai'
@@ -46,6 +47,13 @@ Requires-Dist: litellm>=1.73.6; extra == 'all'
 Requires-Dist: mcp>=1.10.1; extra == 'all'
 Requires-Dist: qdrant-client>=1.14.3; extra == 'all'
 Requires-Dist: uvicorn>=0.34.0; extra == 'all'
+Provides-Extra: genai
+Requires-Dist: fastapi>=0.115.6; extra == 'genai'
+Requires-Dist: instructor>=1.9.0; extra == 'genai'
+Requires-Dist: litellm>=1.73.6; extra == 'genai'
+Requires-Dist: mcp>=1.10.1; extra == 'genai'
+Requires-Dist: qdrant-client>=1.14.3; extra == 'genai'
+Requires-Dist: uvicorn>=0.34.0; extra == 'genai'
 Provides-Extra: mcp
 Requires-Dist: mcp>=1.10.1; extra == 'mcp'
 Provides-Extra: serve

hammad_python-0.0.21/hammad/__init__.py

@@ -0,0 +1,50 @@
+"""hammad-python"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+from ._internal import create_getattr_importer as __hammad_importer__
+
+if TYPE_CHECKING:
+    # hammad.cache
+    from .cache import cached, Cache
+
+    # hammad.cli
+    from .cli import print, animate, input
+
+    # hammad.formatting
+    from .formatting.json import convert_to_json_schema
+    from .formatting.text import convert_to_text, convert_type_to_text
+
+    # hammad.logging
+    from .logging.logger import Logger, create_logger
+    from .logging.decorators import trace, trace_cls, trace_function, trace_http
+
+
+__all__ = [
+    # hammad.cache
+    "cached",
+    "Cache",
+    # hammad.cli
+    "print",
+    "animate",
+    "input",
+    # hammad.formatting
+    "convert_to_json_schema",
+    "convert_to_text",
+    "convert_type_to_text",
+    # hammad.logging
+    "Logger",
+    "create_logger",
+    "trace",
+    "trace_cls",
+    "trace_function",
+    "trace_http",
+]
+
+
+__getattr__ = __hammad_importer__(__all__)
+
+
+def __dir__() -> list[str]:
+    return __all__

{hammad_python-0.0.19 → hammad_python-0.0.21}/hammad/_internal.py

@@ -9,6 +9,7 @@ import hashlib
 
 # pretty
 from rich.traceback import install
+
 install()
 
 __all__ = ("create_getattr_importer",)

{hammad_python-0.0.19 → hammad_python-0.0.21}/hammad/cli/_runner.py

@@ -35,10 +35,7 @@ if TYPE_CHECKING:
     )
 
 
-__all__ = (
-    "CLIRunner",
-)
-
+__all__ = ("CLIRunner",)
 
 
 class CLIRunner:
@@ -54,7 +51,6 @@ class CLIRunner:
         flush: bool = False,
     ) -> None: ...
 
-
     @overload
     @staticmethod
     def print(
@@ -70,7 +66,6 @@ class CLIRunner:
         live: "CLIStyleLiveSettings | int | None" = None,
     ) -> None: ...
 
-
     @staticmethod
     def print(
         *values: object,
@@ -109,6 +104,7 @@ class CLIRunner:
             Live settings object if live=True, otherwise None
         """
         from ..cli import print as _run_cli_print_fn
+
         return _run_cli_print_fn(
             *values,
             sep=sep,
@@ -171,6 +167,7 @@ class CLIRunner:
             The user's input, potentially validated and converted according to the schema.
         """
         from ..cli import input as _run_cli_input_fn
+
         return _run_cli_input_fn(
             prompt=prompt,
             schema=schema,
@@ -188,7 +185,9 @@ class CLIRunner:
     @staticmethod
     def animate(
         renderable: "RenderableType | str",
-        type: Literal["flashing", "pulsing", "shaking", "typing", "spinning", "rainbow"],
+        type: Literal[
+            "flashing", "pulsing", "shaking", "typing", "spinning", "rainbow"
+        ],
         duration: Optional[float] = None,
         # Animation parameters (defaults are handled by the specific animation classes)
         speed: Optional[float] = None,
@@ -239,6 +238,7 @@ class CLIRunner:
             vertical_overflow: How to handle vertical overflow
         """
         from ..cli import animate as _run_cli_animate_fn
+
         _run_cli_animate_fn(
             renderable=renderable,
             type=type,
@@ -262,4 +262,4 @@ class CLIRunner:
             console=console,
             screen=screen,
             vertical_overflow=vertical_overflow,
-        )
+        )

{hammad_python-0.0.19 → hammad_python-0.0.21}/hammad/cli/plugins.py

@@ -159,6 +159,7 @@ def print(
     title: Optional[str] = None,
     expand: Optional[bool] = None,
     live: "CLIStyleLiveSettings | int | None" = None,
+    duration: Optional[float] = None,
     transient: bool = False,
     new_line_start: bool = False,
 ) -> None:
@@ -190,6 +191,7 @@ def print(
         title : Title for panel rendering.
         expand : Whether to expand panel to full width.
         live : A dictionary of live settings or an integer in seconds to run the print in a live renderable.
+        duration : The duration of the live renderable.
         transient : Whether to clear the output after completion.
         new_line_start : Start with a new line before printing.
 
@@ -221,6 +223,7 @@ def print(
         and padding is None
         and title is None
         and expand is None
+        and not transient
     ):
         builtins.print(*values, sep=sep, end=end, file=file, flush=flush)
         return
@@ -250,7 +253,7 @@ def print(
 
             live_settings: CLIStyleLiveSettings = {
                 "duration": float(live),
-                "transient": False,  # Changed to False for testing
+                "transient": transient,  # Use the transient parameter
             }
         else:
             live_settings = live
@@ -281,19 +284,41 @@ def print(
         get_console = _get_rich_console()
         Console, _ = _get_rich_console_classes()
         console = get_console() if file is None else Console(file=file)
-        console.print(
-            styled_content,
-            end=end,
-            justify=justify,
-            overflow=overflow,
-            no_wrap=no_wrap,
-            emoji=emoji,
-            markup=markup,
-            highlight=highlight,
-            width=width,
-            height=height,
-            new_line_start=new_line_start,
-        )
+
+        if transient:
+            # Use Rich's Live with transient for temporary output
+            import time
+            from rich.live import Live
+
+            # Auto-set duration to 2.5 when transient=True and duration is None
+            display_duration = duration if duration is not None else 2.5
+
+            with Live(
+                styled_content,
+                console=console,
+                refresh_per_second=1,
+                transient=True,
+                auto_refresh=False,
+            ) as live:
+                live.update(styled_content)
+                live.refresh()
+                time.sleep(
+                    display_duration
+                )  # Use duration parameter for transient content
+        else:
+            console.print(
+                styled_content,
+                end=end,
+                justify=justify,
+                overflow=overflow,
+                no_wrap=no_wrap,
+                emoji=emoji,
+                markup=markup,
+                highlight=highlight,
+                width=width,
+                height=height,
+                new_line_start=new_line_start,
+            )
 
 
 class InputError(Exception):
@@ -771,10 +796,10 @@ def animate(
         animation = animations["CLIFlashingAnimation"](
             renderable,
             speed=speed if speed is not None else 0.5,
-            colors=colors, # Class handles default if None
+            colors=colors,  # Class handles default if None
             on_color=on_color if on_color is not None else "white",
             off_color=off_color if off_color is not None else "dim white",
-            duration=duration, # Base class handles default if None
+            duration=duration,  # Base class handles default if None
         )
     elif type == "pulsing":
         animation = animations["CLIPulsingAnimation"](
@@ -783,39 +808,43 @@ def animate(
             min_opacity=min_opacity if min_opacity is not None else 0.3,
             max_opacity=max_opacity if max_opacity is not None else 1.0,
             color=color if color is not None else "white",
-            duration=duration, # Base class handles default if None
+            duration=duration,  # Base class handles default if None
         )
     elif type == "shaking":
         animation = animations["CLIShakingAnimation"](
             renderable,
             intensity=intensity if intensity is not None else 1,
             speed=speed if speed is not None else 0.1,
-            duration=duration, # Base class handles default if None
+            duration=duration,  # Base class handles default if None
         )
     elif type == "typing":
         # Note: CLITypingAnimation expects 'text', assuming renderable is a string here.
-        animation = animations["CLITypingAnimation"](
+        animation = animations[
+            "CLITypingAnimation"
+        ](
             renderable,
-            speed=speed if speed is not None else 0.05, # Pass animate's speed, using CLITypingAnimation's speed default
-            typing_speed=typing_speed, # Pass animate's typing_speed, CLITypingAnimation handles its None default
+            speed=speed
+            if speed is not None
+            else 0.05,  # Pass animate's speed, using CLITypingAnimation's speed default
+            typing_speed=typing_speed,  # Pass animate's typing_speed, CLITypingAnimation handles its None default
             cursor=cursor if cursor is not None else "█",
             show_cursor=show_cursor if show_cursor is not None else True,
-            duration=duration, # Base class handles default if None
+            duration=duration,  # Base class handles default if None
         )
     elif type == "spinning":
         animation = animations["CLISpinningAnimation"](
             renderable,
-            frames=frames, # Class handles default if None
+            frames=frames,  # Class handles default if None
             speed=speed if speed is not None else 0.1,
             prefix=prefix if prefix is not None else True,
-            duration=duration, # Base class handles default if None
+            duration=duration,  # Base class handles default if None
         )
     elif type == "rainbow":
         animation = animations["CLIRainbowAnimation"](
             renderable,
             speed=speed if speed is not None else 0.5,
-            colors=colors, # Class handles default if None
-            duration=duration, # Base class handles default if None
+            colors=colors,  # Class handles default if None
+            duration=duration,  # Base class handles default if None
         )
     else:
         raise ValueError(f"Unknown animation type: {type}")

{hammad_python-0.0.19 → hammad_python-0.0.21}/hammad/cli/styles/utils.py

@@ -119,8 +119,8 @@ def style_renderable(
     style_settings: CLIStyleRenderableSettings | None = None,
     bg: CLIStyleBackgroundType | None = None,
     bg_settings: CLIStyleBackgroundSettings | None = None,
-    border = None,
-    padding = None,
+    border=None,
+    padding=None,
     title: str | None = None,
     expand: bool | None = None,
 ):
@@ -383,7 +383,7 @@ def style_renderable(
                             except Exception:
                                 # Skip property if processing fails
                                 continue
-                    
+
                     # Handle direct panel parameters
                     if title is not None:
                         panel_kwargs["title"] = title
@@ -394,6 +394,7 @@ def style_renderable(
                     if border is not None:
                         try:
                             from rich import box as rich_box_module
+
                             box_map = {
                                 "ascii": rich_box_module.ASCII,
                                 "ascii2": rich_box_module.ASCII2,
@@ -516,7 +517,7 @@ def style_renderable(
                         panel_kwargs = {}
                         bg_style = Style(bgcolor=bg)
                         panel_kwargs["style"] = bg_style
-                        
+
                         # Handle direct panel parameters even with simple bg
                         if title is not None:
                             panel_kwargs["title"] = title
@@ -527,6 +528,7 @@ def style_renderable(
                         if border is not None:
                             try:
                                 from rich import box as rich_box_module
+
                                 box_map = {
                                     "ascii": rich_box_module.ASCII,
                                     "ascii2": rich_box_module.ASCII2,
@@ -558,17 +560,22 @@ def style_renderable(
                             except Exception:
                                 # Use default box if box processing fails
                                 pass
-                        
+
                         return Panel(styled_renderable, **panel_kwargs)
                     except Exception:
                         # Fallback to styled renderable if panel creation fails
                         return styled_renderable
                 else:
                     # Handle panel parameters without background
-                    if title is not None or padding is not None or expand is not None or border is not None:
+                    if (
+                        title is not None
+                        or padding is not None
+                        or expand is not None
+                        or border is not None
+                    ):
                         try:
                             panel_kwargs = {}
-                            
+
                             if title is not None:
                                 panel_kwargs["title"] = title
                             if padding is not None:
@@ -578,6 +585,7 @@ def style_renderable(
                             if border is not None:
                                 try:
                                     from rich import box as rich_box_module
+
                                     box_map = {
                                         "ascii": rich_box_module.ASCII,
                                         "ascii2": rich_box_module.ASCII2,
@@ -609,7 +617,7 @@ def style_renderable(
                                 except Exception:
                                     # Use default box if box processing fails
                                     pass
-                            
+
                             return Panel(styled_renderable, **panel_kwargs)
                         except Exception:
                             # Fallback to styled renderable if panel creation fails

{hammad_python-0.0.19 → hammad_python-0.0.21}/hammad/data/__init__.py

@@ -47,7 +47,6 @@ __all__ = (
     # hammad.data.types
     "BaseText",
     "Text",
-
     # hammad.data.models
     "Model",
     "model_settings",
@@ -55,7 +54,6 @@ __all__ = (
     "validator",
     "is_field",
     "is_model",
-
     # hammad.data.collections
     "Collection",
     "TantivyCollectionIndex",
@@ -64,12 +62,10 @@ __all__ = (
     "TantivyCollectionIndexQuerySettings",
     "QdrantCollectionIndexSettings",
     "QdrantCollectionIndexQuerySettings",
-
     # hammad.data.sql
     "DatabaseItemType",
     "DatabaseItem",
     "Database",
-
     # hammad.data.configurations
     "Configuration",
 )
@@ -80,4 +76,4 @@ __getattr__ = create_getattr_importer(__all__)
 
 def __dir__() -> list[str]:
     """Get the attributes of the hammad.data module."""
-    return list(__all__)
+    return list(__all__)

{hammad_python-0.0.19 → hammad_python-0.0.21}/hammad/data/collections/__init__.py

@@ -5,7 +5,7 @@ from ..._internal import create_getattr_importer
 
 if TYPE_CHECKING:
     from .collection import Collection
-    
+
     from .indexes import (
         TantivyCollectionIndex,
         QdrantCollectionIndex,
@@ -25,7 +25,6 @@ if TYPE_CHECKING:
 __all__ = (
     # hammad.data.collections.collection
     "Collection",
-
     # hammad.data.collections.indexes
     "TantivyCollectionIndex",
     "QdrantCollectionIndex",
@@ -41,4 +40,4 @@ __getattr__ = create_getattr_importer(__all__)
 
 def __dir__() -> list[str]:
     """Get the attributes of the hammad.data.collections module."""
-    return list(__all__)
+    return list(__all__)

{hammad_python-0.0.19 → hammad_python-0.0.21}/hammad/data/collections/collection.py

@@ -28,7 +28,7 @@ if TYPE_CHECKING:
         DistanceMetric,
     )
     from ..sql.types import DatabaseItemType
-    from ...genai.embedding_models.embedding_model_name import EmbeddingModelName
+    from ...genai.models.embeddings.types import EmbeddingModelName
 else:
     from .indexes.tantivy.index import TantivyCollectionIndex
     from .indexes.qdrant.index import QdrantCollectionIndex, VectorSearchResult
@@ -44,11 +44,11 @@ class Collection:
     """
     A unified collection factory that creates the appropriate collection index type
     based on the provided parameters.
-    
+
     This class acts as a factory and doesn't contain its own logic - it simply
     returns instances of TantivyCollectionIndex or QdrantCollectionIndex based on the
     vector parameter.
-    
+
     The main difference from the old approach is that now collections are 'unified'
     - there's no separate collections interface. Each collection directly uses either
     a Tantivy or Qdrant index with SQL Database as the storage backend.
@@ -83,7 +83,9 @@ class Collection:
         distance_metric: "DistanceMetric" = "dot",
         settings: Optional["QdrantCollectionIndexSettings"] = None,
         query_settings: Optional["QdrantCollectionIndexQuerySettings"] = None,
-        embedding_model: Optional["EmbeddingModelName"] = "openai/text-embedding-3-small",
+        embedding_model: Optional[
+            "EmbeddingModelName"
+        ] = "openai/text-embedding-3-small",
         embedding_dimensions: Optional[int] = None,
         embedding_api_key: Optional[str] = None,
         embedding_base_url: Optional[str] = None,
@@ -105,11 +107,20 @@ class Collection:
         # Tantivy-specific parameters
         fast: bool = True,
         # Unified settings parameters
-        settings: Optional[Union["TantivyCollectionIndexSettings", "QdrantCollectionIndexSettings"]] = None,
-        query_settings: Optional[Union["TantivyCollectionIndexQuerySettings", "QdrantCollectionIndexQuerySettings"]] = None,
+        settings: Optional[
+            Union["TantivyCollectionIndexSettings", "QdrantCollectionIndexSettings"]
+        ] = None,
+        query_settings: Optional[
+            Union[
+                "TantivyCollectionIndexQuerySettings",
+                "QdrantCollectionIndexQuerySettings",
+            ]
+        ] = None,
         # Vector/Qdrant-specific parameters
         distance_metric: "DistanceMetric" = "dot",
-        embedding_model: Optional["EmbeddingModelName"] = "openai/text-embedding-3-small",
+        embedding_model: Optional[
+            "EmbeddingModelName"
+        ] = "openai/text-embedding-3-small",
         embedding_dimensions: Optional[int] = None,
         embedding_api_key: Optional[str] = None,
         embedding_base_url: Optional[str] = None,
@@ -120,7 +131,7 @@ class Collection:
     ) -> Union["TantivyCollectionIndex", "QdrantCollectionIndex"]:
         """
         Create a collection of the specified type.
-        
+
         Args:
             name: Name of the collection
             schema: Optional schema type for validation
@@ -128,26 +139,26 @@ class Collection:
             path: File path for storage (None = in-memory)
             vector: Whether this is a vector collection (True) or text search collection (False)
             vector_size: Size of vectors (required for vector collections)
-            
+
             # Tantivy parameters (for non-vector collections):
             fast: Whether to use fast schema building & indexing
-            
+
             # Unified parameters:
             settings: Collection settings (TantivyCollectionIndexSettings or QdrantCollectionIndexSettings)
             query_settings: Query behavior settings (TantivyCollectionIndexQuerySettings or QdrantCollectionIndexQuerySettings)
-            
+
             # Qdrant parameters (for vector collections):
             distance_metric: Distance metric for similarity search
             embedding_model: The embedding model to use (e.g., 'openai/text-embedding-3-small')
             embedding_dimensions: Number of dimensions for embeddings
             embedding_api_key: API key for the embedding service
             embedding_base_url: Base URL for the embedding service
-            
+
             # Rerank parameters (for vector collections):
             rerank_model: The rerank model to use (e.g., 'cohere/rerank-english-v3.0')
             rerank_api_key: API key for the rerank service
             rerank_base_url: Base URL for the rerank service
-            
+
         Returns:
             A TantivyCollectionIndex or QdrantCollectionIndex instance
         """
@@ -181,7 +192,7 @@ class Collection:
                 settings=settings,
                 query_settings=query_settings,
             )
-        
+
 
 @overload
 def create_collection(
@@ -197,6 +208,7 @@ def create_collection(
     query_settings: Optional["TantivyCollectionIndexQuerySettings"] = None,
 ) -> "TantivyCollectionIndex": ...
 
+
 @overload
 def create_collection(
     name: str = "default",
@@ -213,6 +225,7 @@ def create_collection(
     embedding_function: Optional[Callable[[Any], List[float]]] = None,
 ) -> "QdrantCollectionIndex": ...
 
+
 def create_collection(
     name: str = "default",
     *,
@@ -224,8 +237,14 @@ def create_collection(
     # Tantivy-specific parameters
     fast: bool = True,
     # Unified settings parameters
-    settings: Optional[Union["TantivyCollectionIndexSettings", "QdrantCollectionIndexSettings"]] = None,
-    query_settings: Optional[Union["TantivyCollectionIndexQuerySettings", "QdrantCollectionIndexQuerySettings"]] = None,
+    settings: Optional[
+        Union["TantivyCollectionIndexSettings", "QdrantCollectionIndexSettings"]
+    ] = None,
+    query_settings: Optional[
+        Union[
+            "TantivyCollectionIndexQuerySettings", "QdrantCollectionIndexQuerySettings"
+        ]
+    ] = None,
     # Vector/Qdrant-specific parameters
     distance_metric: "DistanceMetric" = "dot",
     embedding_function: Optional[Callable[[Any], List[float]]] = None,
@@ -233,7 +252,7 @@ def create_collection(
     """
     Create a data collection of the specified type. Collections are a unified
     interface for creating searchable, vectorizable data stores.
-    
+
     Args:
         name: Name of the collection
         schema: Optional schema type for validation
@@ -241,21 +260,21 @@ def create_collection(
         path: File path for storage (None = in-memory)
         vector: Whether this is a vector collection (True) or text search collection (False)
         vector_size: Size of vectors (required for vector collections)
-        
+
         # Tantivy parameters (for non-vector collections):
         fast: Whether to use fast schema building & indexing
-        
+
         # Unified parameters:
         settings: Collection settings (TantivyCollectionIndexSettings or QdrantCollectionIndexSettings)
         query_settings: Query behavior settings (TantivyCollectionIndexQuerySettings or QdrantCollectionIndexQuerySettings)
-        
+
         # Qdrant parameters (for vector collections):
         distance_metric: Distance metric for similarity search
         embedding_model: The embedding model to use (e.g., 'openai/text-embedding-3-small')
         embedding_dimensions: Number of dimensions for embeddings
         embedding_api_key: API key for the embedding service
         embedding_base_url: Base URL for the embedding service
-        
+
     Returns:
         A TantivyCollectionIndex or QdrantCollectionIndex instance
     """
@@ -271,4 +290,4 @@ def create_collection(
         query_settings=query_settings,
         distance_metric=distance_metric,
         embedding_function=embedding_function,
-    )
+    )

{hammad_python-0.0.19 → hammad_python-0.0.21}/hammad/data/collections/indexes/__init__.py

@@ -34,4 +34,4 @@ __getattr__ = create_getattr_importer(__all__)
 
 def __dir__() -> list[str]:
     """Get the attributes of the hammad.data.collections.indexes module."""
-    return list(__all__)
+    return list(__all__)

hammad_python-0.0.21/hammad/data/collections/indexes/qdrant/__init__.py

@@ -0,0 +1 @@
+"""hammad.lib.data.collections.indexes.qdrant"""