prompty 0.1.1__py3-none-any.whl → 0.1.8__py3-none-any.whl

prompty/__init__.py

@@ -2,6 +2,8 @@ import json
 import traceback
 from pathlib import Path
 from typing import Dict, List, Union
+
+from .tracer import trace
 from .core import (
     Frontmatter,
     InvokerFactory,
@@ -46,6 +48,7 @@ def load_global_config(
     return {}
 
 
+@trace(description="Create a headless prompty object for programmatic use.")
 def headless(
     api: str,
     content: str | List[str] | dict,
@@ -53,6 +56,38 @@ def headless(
     parameters: Dict[str, any] = {},
     connection: str = "default",
 ) -> Prompty:
+    """Create a headless prompty object for programmatic use.
+
+    Parameters
+    ----------
+    api : str
+        The API to use for the model
+    content : str | List[str] | dict
+        The content to process
+    configuration : Dict[str, any], optional
+        The configuration to use, by default {}
+    parameters : Dict[str, any], optional
+        The parameters to use, by default {}
+    connection : str, optional
+        The connection to use, by default "default"
+
+    Returns
+    -------
+    Prompty
+        The headless prompty object
+
+    Example
+    -------
+    >>> import prompty
+    >>> p = prompty.headless(
+            api="embedding",
+            configuration={"type": "azure", "azure_deployment": "text-embedding-ada-002"},
+            content="hello world",
+        )
+    >>> emb = prompty.execute(p)
+
+    """
+
     # get caller's path (to get relative path for prompty.json)
     caller = Path(traceback.extract_stack()[-2].filename)
     templateSettings = TemplateSettings(type="NOOP", parser="NOOP")
@@ -70,11 +105,33 @@ def headless(
     return Prompty(model=modelSettings, template=templateSettings, content=content)
 
 
+@trace(description="Load a prompty file.")
 def load(prompty_file: str, configuration: str = "default") -> Prompty:
+    """Load a prompty file.
+
+    Parameters
+    ----------
+    prompty_file : str
+        The path to the prompty file
+    configuration : str, optional
+        The configuration to use, by default "default"
+
+    Returns
+    -------
+    Prompty
+        The loaded prompty object
+
+    Example
+    -------
+    >>> import prompty
+    >>> p = prompty.load("prompts/basic.prompty")
+    >>> print(p)
+    """
+
     p = Path(prompty_file)
     if not p.is_absolute():
         # get caller's path (take into account trace frame)
-        caller = Path(traceback.extract_stack()[-2].filename)
+        caller = Path(traceback.extract_stack()[-3].filename)
         p = Path(caller.parent / p).resolve().absolute()
 
     # load dictionary from prompty file
@@ -175,11 +232,32 @@ def load(prompty_file: str, configuration: str = "default") -> Prompty:
         )
     return p
 
-
+@trace(description="Prepare the inputs for the prompt.")
 def prepare(
     prompt: Prompty,
     inputs: Dict[str, any] = {},
 ):
+    """ Prepare the inputs for the prompt.
+
+    Parameters
+    ----------
+    prompt : Prompty
+        The prompty object
+    inputs : Dict[str, any], optional
+        The inputs to the prompt, by default {}
+
+    Returns
+    -------
+    dict
+        The prepared and hidrated template shaped to the LLM model
+
+    Example
+    -------
+    >>> import prompty
+    >>> p = prompty.load("prompts/basic.prompty")
+    >>> inputs = {"name": "John Doe"}
+    >>> content = prompty.prepare(p, inputs)
+    """
     inputs = param_hoisting(inputs, prompt.sample)
 
     if prompt.template.type == "NOOP":
@@ -200,7 +278,7 @@ def prepare(
 
     return result
 
-
+@trace(description="Run the prepared Prompty content against the model.")
 def run(
     prompt: Prompty,
     content: dict | list | str,
@@ -208,7 +286,34 @@ def run(
     parameters: Dict[str, any] = {},
     raw: bool = False,
 ):
-    # invoker = InvokerFactory()
+    """Run the prepared Prompty content.
+
+    Parameters
+    ----------
+    prompt : Prompty
+        The prompty object
+    content : dict | list | str
+        The content to process
+    configuration : Dict[str, any], optional
+        The configuration to use, by default {}
+    parameters : Dict[str, any], optional
+        The parameters to use, by default {}
+    raw : bool, optional
+        Whether to skip processing, by default False
+
+    Returns
+    -------
+    any
+        The result of the prompt
+
+    Example
+    -------
+    >>> import prompty
+    >>> p = prompty.load("prompts/basic.prompty")
+    >>> inputs = {"name": "John Doe"}
+    >>> content = prompty.prepare(p, inputs)
+    >>> result = prompty.run(p, content)
+    """
 
     if configuration != {}:
         prompt.model.configuration = param_hoisting(
@@ -234,7 +339,7 @@ def run(
 
     return result
 
-
+@trace(description="Execute a prompty")
 def execute(
     prompt: Union[str, Prompty],
     configuration: Dict[str, any] = {},
@@ -243,12 +348,39 @@ def execute(
     raw: bool = False,
     connection: str = "default",
 ):
-
+    """Execute a prompty.
+
+    Parameters
+    ----------
+    prompt : Union[str, Prompty]
+        The prompty object or path to the prompty file
+    configuration : Dict[str, any], optional
+        The configuration to use, by default {}
+    parameters : Dict[str, any], optional
+        The parameters to use, by default {}
+    inputs : Dict[str, any], optional
+        The inputs to the prompt, by default {}
+    raw : bool, optional
+        Whether to skip processing, by default False
+    connection : str, optional
+        The connection to use, by default "default"
+
+    Returns
+    -------
+    any
+        The result of the prompt
+
+    Example
+    -------
+    >>> import prompty
+    >>> inputs = {"name": "John Doe"}
+    >>> result = prompty.execute("prompts/basic.prompty", inputs=inputs)
+    """
     if isinstance(prompt, str):
         path = Path(prompt)
         if not path.is_absolute():
             # get caller's path (take into account trace frame)
-            caller = Path(traceback.extract_stack()[-2].filename)
+            caller = Path(traceback.extract_stack()[-3].filename)
             path = Path(caller.parent / path).resolve().absolute()
         prompt = load(path, connection)
 

prompty/cli.py

@@ -0,0 +1,85 @@
+import os
+import json
+import click
+
+
+from pathlib import Path
+from pydantic import BaseModel
+
+from . import load, execute
+from .tracer import trace, Trace, PromptyTracer
+from dotenv import load_dotenv
+
+load_dotenv()
+Trace.add_tracer("prompty", PromptyTracer())
+
+def normalize_path(p, create_dir=False) -> Path:
+    path = Path(p)
+    if not path.is_absolute():
+        path = Path(os.getcwd()).joinpath(path).absolute().resolve()
+    else:
+        path = path.absolute().resolve()
+
+    if create_dir:
+        if not path.exists():
+            print(f"Creating directory {str(path)}")
+            os.makedirs(str(path))
+
+    return path
+
+
+@trace
+def chat_mode(prompt_path: str):
+    W = "\033[0m"   # white (normal)
+    R = "\033[31m"  # red
+    G = "\033[32m"  # green
+    O = "\033[33m"  # orange
+    B = "\033[34m"  # blue
+    P = "\033[35m"  # purple
+    print(f"Executing {str(prompt_path)} in chat mode...")
+    prompty = load(str(prompt_path))
+    if "chat_history" not in prompty.sample:
+        print(
+            f"{R}{str(prompt_path)} needs to have a chat_history input to work in chat mode{W}"
+        )
+        return
+    else:
+        chat_history = prompty.sample["chat_history"]
+        while True:
+            user_input = input(f"{B}User:{W} ")
+            if user_input == "exit":
+                break
+            chat_history.append({"role": "user", "content": user_input})
+            # reloadable prompty file
+            result = execute(prompt_path, inputs={"chat_history": chat_history})
+            print(f"\n{G}Assistant:{W} {result}\n")
+            chat_history.append({"role": "assistant", "content": result})
+    print("Goodbye!")
+
+
+@click.command()
+@click.option("--source", "-s", required=True)
+@click.option("--verbose", "-v", is_flag=True)
+@click.option("--chat", "-c", is_flag=True)
+@click.version_option()
+@trace
+def run(source, verbose, chat):
+    prompt_path = normalize_path(source)
+    if not prompt_path.exists():
+        print(f"{str(prompt_path)} does not exist")
+        return
+
+    if chat:
+        chat_mode(str(prompt_path))
+    else:
+        result = execute(str(prompt_path), raw=verbose)
+        if issubclass(type(result), BaseModel):
+            print(json.dumps(result.model_dump(), indent=4))
+        elif isinstance(result, list):
+            print(json.dumps([item.model_dump() for item in result], indent=4))
+        else:
+            print(result)
+
+
+if __name__ == "__main__":
+    chat_mode(source="./tests/prompts/basic.prompt")

prompty/core.py

@@ -7,26 +7,82 @@ import json
 import abc
 from pathlib import Path
 from pydantic import BaseModel, Field, FilePath
-from typing import List, Literal, Dict, Callable, TypeVar
-
-
-T = TypeVar("T")
+from typing import List, Literal, Dict, Callable, Set, TypeVar
+from .tracer import trace
 
 
 class PropertySettings(BaseModel):
+    """PropertySettings class to define the properties of the model
+
+    Attributes
+    ----------
+    type : str
+        The type of the property
+    default : any
+        The default value of the property
+    description : str
+        The description of the property
+    """
+
     type: Literal["string", "number", "array", "object", "boolean"]
     default: str | int | float | List | dict | bool = Field(default=None)
     description: str = Field(default="")
 
 
 class ModelSettings(BaseModel):
+    """ModelSettings class to define the model of the prompty
+
+    Attributes
+    ----------
+    api : str
+        The api of the model
+    configuration : dict
+        The configuration of the model
+    parameters : dict
+        The parameters of the model
+    response : dict
+        The response of the model
+    """
+
     api: str = Field(default="")
     configuration: dict = Field(default={})
     parameters: dict = Field(default={})
     response: dict = Field(default={})
 
-    def model_dump_safe(self) -> dict:
-        d = self.model_dump()
+    def model_dump(
+        self,
+        *,
+        mode: str = "python",
+        include: (
+            Set[int] | Set[str] | Dict[int, os.Any] | Dict[str, os.Any] | None
+        ) = None,
+        exclude: (
+            Set[int] | Set[str] | Dict[int, os.Any] | Dict[str, os.Any] | None
+        ) = None,
+        context: os.Any | None = None,
+        by_alias: bool = False,
+        exclude_unset: bool = False,
+        exclude_defaults: bool = False,
+        exclude_none: bool = False,
+        round_trip: bool = False,
+        warnings: bool | Literal["none"] | Literal["warn"] | Literal["error"] = True,
+        serialize_as_any: bool = False,
+    ) -> Dict[str, os.Any]:
+        """Method to dump the model in a safe way"""
+        d = super().model_dump(
+            mode=mode,
+            include=include,
+            exclude=exclude,
+            context=context,
+            by_alias=by_alias,
+            exclude_unset=exclude_unset,
+            exclude_defaults=exclude_defaults,
+            exclude_none=exclude_none,
+            round_trip=round_trip,
+            warnings=warnings,
+            serialize_as_any=serialize_as_any,
+        )
+
         d["configuration"] = {
             k: "*" * len(v) if "key" in k.lower() or "secret" in k.lower() else v
             for k, v in d["configuration"].items()
@@ -35,11 +91,55 @@ class ModelSettings(BaseModel):
 
 
 class TemplateSettings(BaseModel):
+    """TemplateSettings class to define the template of the prompty
+
+    Attributes
+    ----------
+    type : str
+        The type of the template
+    parser : str
+        The parser of the template
+    """
+
     type: str = Field(default="jinja2")
     parser: str = Field(default="")
 
 
 class Prompty(BaseModel):
+    """Prompty class to define the prompty
+
+    Attributes
+    ----------
+    name : str
+        The name of the prompty
+    description : str
+        The description of the prompty
+    authors : List[str]
+        The authors of the prompty
+    tags : List[str]
+        The tags of the prompty
+    version : str
+        The version of the prompty
+    base : str
+        The base of the prompty
+    basePrompty : Prompty
+        The base prompty
+    model : ModelSettings
+        The model of the prompty
+    sample : dict
+        The sample of the prompty
+    inputs : Dict[str, PropertySettings]
+        The inputs of the prompty
+    outputs : Dict[str, PropertySettings]
+        The outputs of the prompty
+    template : TemplateSettings
+        The template of the prompty
+    file : FilePath
+        The file of the prompty
+    content : str | List[str] | dict
+        The content of the prompty
+    """
+
     # metadata
     name: str = Field(default="")
     description: str = Field(default="")
@@ -69,7 +169,7 @@ class Prompty(BaseModel):
         for k, v in self:
             if v != "" and v != {} and v != [] and v != None:
                 if k == "model":
-                    d[k] = v.model_dump_safe()
+                    d[k] = v.model_dump()
                 elif k == "template":
                     d[k] = v.model_dump()
                 elif k == "inputs" or k == "outputs":
@@ -88,11 +188,6 @@ class Prompty(BaseModel):
                     d[k] = v
         return d
 
-    # generate json representation of the prompty
-    def to_safe_json(self) -> str:
-        d = self.to_safe_dict()
-        return json.dumps(d)
-
     @staticmethod
     def _process_file(file: str, parent: Path) -> any:
         file = Path(parent / Path(file)).resolve().absolute()
@@ -180,18 +275,57 @@ def param_hoisting(
 
 
 class Invoker(abc.ABC):
+    """Abstract class for Invoker
+
+    Attributes
+    ----------
+    prompty : Prompty
+        The prompty object
+    name : str
+        The name of the invoker
+
+    """
+
     def __init__(self, prompty: Prompty) -> None:
         self.prompty = prompty
+        self.name = self.__class__.__name__
 
     @abc.abstractmethod
     def invoke(self, data: any) -> any:
+        """Abstract method to invoke the invoker
+
+        Parameters
+        ----------
+        data : any
+            The data to be invoked
+
+        Returns
+        -------
+        any
+            The invoked
+        """
         pass
 
+    @trace
     def __call__(self, data: any) -> any:
+        """Method to call the invoker
+
+        Parameters
+        ----------
+        data : any
+            The data to be invoked
+
+        Returns
+        -------
+        any
+            The invoked
+        """
         return self.invoke(data)
 
 
 class InvokerFactory:
+    """Factory class for Invoker"""
+
     _renderers: Dict[str, Invoker] = {}
     _parsers: Dict[str, Invoker] = {}
     _executors: Dict[str, Invoker] = {}
@@ -267,6 +401,8 @@ class NoOp(Invoker):
 
 
 class Frontmatter:
+    """Frontmatter class to extract frontmatter from string."""
+
     _yaml_delim = r"(?:---|\+\+\+)"
     _yaml = r"(.*?)"
     _content = r"\s*(.+)$"
@@ -275,8 +411,12 @@ class Frontmatter:
 
     @classmethod
     def read_file(cls, path):
-        """Reads file at path and returns dict with separated frontmatter.
-        See read() for more info on dict return value.
+        """Returns dict with separated frontmatter from file.
+
+        Parameters
+        ----------
+        path : str
+            The path to the file
         """
         with open(path, encoding="utf-8") as file:
             file_contents = file.read()
@@ -286,10 +426,16 @@ class Frontmatter:
     def read(cls, string):
         """Returns dict with separated frontmatter from string.
 
-        Returned dict keys:
-        attributes -- extracted YAML attributes in dict form.
-        body -- string contents below the YAML separators
-        frontmatter -- string representation of YAML
+        Parameters
+        ----------
+        string : str
+            The string to extract frontmatter from
+
+
+        Returns
+        -------
+        dict
+            The separated frontmatter
         """
         fmatter = ""
         body = ""

prompty/executors.py

@@ -1,14 +1,18 @@
 import azure.identity
+from .tracer import Trace
 from openai import AzureOpenAI
 from .core import Invoker, InvokerFactory, Prompty
-from pathlib import Path
+import importlib.metadata
+
+VERSION = importlib.metadata.version("prompty")
 
 
 @InvokerFactory.register_executor("azure")
 @InvokerFactory.register_executor("azure_openai")
 class AzureOpenAIExecutor(Invoker):
+    """ Azure OpenAI Executor  """
     def __init__(self, prompty: Prompty) -> None:
-        self.prompty = prompty
+        super().__init__(prompty)
         kwargs = {
             key: value
             for key, value in self.prompty.model.configuration.items()
@@ -35,7 +39,10 @@ class AzureOpenAIExecutor(Invoker):
             )
 
         self.client = AzureOpenAI(
-            default_headers={"User-Agent": "prompty/0.1.0"},
+            default_headers={
+                "User-Agent": f"prompty{VERSION}",
+                "x-ms-useragent": f"prompty/{VERSION}",
+            },
             **kwargs,
         )
 
@@ -44,12 +51,25 @@ class AzureOpenAIExecutor(Invoker):
         self.parameters = self.prompty.model.parameters
 
     def invoke(self, data: any) -> any:
+        """ Invoke the Azure OpenAI API
+
+        Parameters
+        ----------
+        data : any
+            The data to send to the Azure OpenAI API
+
+        Returns
+        -------
+        any
+            The response from the Azure OpenAI API
+        """
         if self.api == "chat":
             response = self.client.chat.completions.create(
                 model=self.deployment,
                 messages=data if isinstance(data, list) else [data],
                 **self.parameters,
             )
+
         elif self.api == "completion":
             response = self.client.completions.create(
                 prompt=data.item,
@@ -67,4 +87,9 @@ class AzureOpenAIExecutor(Invoker):
         elif self.api == "image":
             raise NotImplementedError("Azure OpenAI Image API is not implemented yet")
 
+        if hasattr(response, "usage") and response.usage:
+            Trace.add("completion_tokens", response.usage.completion_tokens)
+            Trace.add("prompt_tokens", response.usage.prompt_tokens)
+            Trace.add("total_tokens", response.usage.total_tokens)
+
         return response

prompty/parsers.py

@@ -5,12 +5,25 @@ from .core import Invoker, InvokerFactory, Prompty
 
 @InvokerFactory.register_parser("prompty.chat")
 class PromptyChatParser(Invoker):
+    """ Prompty Chat Parser  """
     def __init__(self, prompty: Prompty) -> None:
-        self.prompty = prompty
+        super().__init__(prompty)
         self.roles = ["assistant", "function", "system", "user"]
         self.path = self.prompty.file.parent
 
     def inline_image(self, image_item: str) -> str:
+        """ Inline Image
+
+        Parameters
+        ----------
+        image_item : str
+            The image item to inline
+        
+        Returns
+        -------
+        str
+            The inlined image
+        """
         # pass through if it's a url or base64 encoded
         if image_item.startswith("http") or image_item.startswith("data"):
             return image_item
@@ -32,7 +45,18 @@ class PromptyChatParser(Invoker):
                 )
 
     def parse_content(self, content: str):
-        """for parsing inline images"""
+        """ for parsing inline images
+        
+        Parameters
+        ----------
+        content : str
+            The content to parse
+        
+        Returns
+        -------
+        any
+            The parsed content
+        """
         # regular expression to parse markdown images
         image = r"(?P<alt>!\[[^\]]*\])\((?P<filename>.*?)(?=\"|\))\)"
         matches = re.findall(image, content, flags=re.MULTILINE)
@@ -73,6 +97,18 @@ class PromptyChatParser(Invoker):
             return content
 
     def invoke(self, data: str) -> str:
+        """ Invoke the Prompty Chat Parser
+
+        Parameters
+        ----------
+        data : str
+            The data to parse
+        
+        Returns
+        -------
+        str
+            The parsed data
+        """
         messages = []
         separator = r"(?i)^\s*#?\s*(" + "|".join(self.roles) + r")\s*:\s*\n"
 

prompty/processors.py

@@ -1,3 +1,6 @@
+from .tracer import Trace
+from openai import Stream
+from typing import Iterator
 from pydantic import BaseModel
 from openai.types.completion import Completion
 from .core import Invoker, InvokerFactory, Prompty
@@ -5,7 +8,6 @@ from openai.types.chat.chat_completion import ChatCompletion
 from openai.types.create_embedding_response import CreateEmbeddingResponse
 
 
-
 class ToolCall(BaseModel):
     id: str
     name: str
@@ -16,18 +18,25 @@ class ToolCall(BaseModel):
 @InvokerFactory.register_processor("azure")
 @InvokerFactory.register_processor("azure_openai")
 class OpenAIProcessor(Invoker):
+    """OpenAI/Azure Processor"""
+
     def __init__(self, prompty: Prompty) -> None:
-        self.prompty = prompty
+        super().__init__(prompty)
 
     def invoke(self, data: any) -> any:
+        """Invoke the OpenAI/Azure API
+
+        Parameters
+        ----------
+        data : any
+            The data to send to the OpenAI/Azure API
 
-        assert (
-            isinstance(data, ChatCompletion)
-            or isinstance(data, Completion)
-            or isinstance(data, CreateEmbeddingResponse)
-        )
+        Returns
+        -------
+        any
+            The response from the OpenAI/Azure API
+        """
         if isinstance(data, ChatCompletion):
-            # TODO: Check for streaming response
             response = data.choices[0].message
             # tool calls available in response
             if response.tool_calls:
@@ -51,5 +60,15 @@ class OpenAIProcessor(Invoker):
                 return data.data[0].embedding
             else:
                 return [item.embedding for item in data.data]
+        elif isinstance(data, Iterator):
+
+            def generator():
+                for chunk in data:
+                    if len(chunk.choices) == 1 and chunk.choices[0].delta.content != None:
+                        content = chunk.choices[0].delta.content
+                        Trace.add("stream", content)
+                        yield content
+
+            return generator()
         else:
-            raise ValueError("Invalid data type")
+            return data

prompty/renderers.py

@@ -4,8 +4,9 @@ from .core import Invoker, InvokerFactory, Prompty
 
 @InvokerFactory.register_renderer("jinja2")
 class Jinja2Renderer(Invoker):
+    """ Jinja2 Renderer """
     def __init__(self, prompty: Prompty) -> None:
-        self.prompty = prompty
+        super().__init__(prompty)
         self.templates = {}
         # generate template dictionary
         cur_prompt = self.prompty

prompty/tracer.py

@@ -0,0 +1,231 @@
+import abc
+import json
+import inspect
+import datetime
+from numbers import Number
+import os
+from datetime import datetime
+from pathlib import Path
+from pydantic import BaseModel
+from functools import wraps, partial
+from typing import Any, Callable, Dict, List
+
+
+class Tracer(abc.ABC):
+
+    @abc.abstractmethod
+    def start(self, name: str) -> None:
+        pass
+
+    @abc.abstractmethod
+    def add(self, key: str, value: Any) -> None:
+        pass
+
+    @abc.abstractmethod
+    def end(self) -> None:
+        pass
+
+
+class Trace:
+    _tracers: Dict[str, Tracer] = {}
+
+    @classmethod
+    def add_tracer(cls, name: str, tracer: Tracer) -> None:
+        cls._tracers[name] = tracer
+
+    @classmethod
+    def start(cls, name: str) -> None:
+        for tracer in cls._tracers.values():
+            tracer.start(name)
+
+    @classmethod
+    def add(cls, name: str, value: Any) -> None:
+        for tracer in cls._tracers.values():
+            tracer.add(name, value)
+
+    @classmethod
+    def end(cls) -> None:
+        for tracer in cls._tracers.values():
+            tracer.end()
+
+    @classmethod
+    def clear(cls) -> None:
+        cls._tracers = {}
+
+    @classmethod
+    def register(cls, name: str):
+        def inner_wrapper(wrapped_class: Tracer) -> Callable:
+            cls._tracers[name] = wrapped_class()
+            return wrapped_class
+
+        return inner_wrapper
+
+    @classmethod
+    def to_dict(cls, obj: Any) -> Dict[str, Any]:
+        # simple json types
+        if isinstance(obj, str) or isinstance(obj, Number) or isinstance(obj, bool):
+            return obj
+        # datetime
+        elif isinstance(obj, datetime):
+            return obj.isoformat()
+        # safe Prompty obj serialization
+        elif type(obj).__name__ == "Prompty":
+            return obj.to_safe_dict()
+        # pydantic models have their own json serialization
+        elif isinstance(obj, BaseModel):
+            return obj.model_dump()
+        # recursive list and dict
+        elif isinstance(obj, list):
+            return [Trace.to_dict(item) for item in obj]
+        elif isinstance(obj, dict):
+            return {
+                k: v if isinstance(v, str) else Trace.to_dict(v)
+                for k, v in obj.items()
+            }
+        elif isinstance(obj, Path):
+            return str(obj)
+        # cast to string otherwise...
+        else:
+            return str(obj)
+
+
+def _name(func: Callable, args):
+    if hasattr(func, "__qualname__"):
+        signature = f"{func.__module__}.{func.__qualname__}"
+    else:
+        signature = f"{func.__module__}.{func.__name__}"
+
+    # core invoker gets special treatment
+    core_invoker = signature == "prompty.core.Invoker.__call__"
+    if core_invoker:
+        name = type(args[0]).__name__
+        signature = f"{args[0].__module__}.{args[0].__class__.__name__}.invoke"
+    else:
+        name = func.__name__
+
+    return name, signature
+
+
+def _inputs(func: Callable, args, kwargs) -> dict:
+    ba = inspect.signature(func).bind(*args, **kwargs)
+    ba.apply_defaults()
+
+    inputs = {k: Trace.to_dict(v) for k, v in ba.arguments.items() if k != "self"}
+
+    return inputs
+
+def _results(result: Any) -> dict:
+    return {
+        "result": Trace.to_dict(result) if result is not None else "None",
+    }
+
+def _trace_sync(func: Callable = None, *, description: str = None) -> Callable:
+    description = description or ""
+
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        name, signature = _name(func, args)
+        Trace.start(name)
+        Trace.add("signature", signature)
+        if description and description != "":
+            Trace.add("description", description)
+
+        inputs = _inputs(func, args, kwargs)
+        Trace.add("inputs", inputs)
+
+        result = func(*args, **kwargs)
+        Trace.add("result", _results(result))
+
+        Trace.end()
+
+        return result
+    
+    return wrapper
+
+def _trace_async(func: Callable = None, *, description: str = None) -> Callable:
+    description = description or ""
+
+    @wraps(func)
+    async def wrapper(*args, **kwargs):
+        name, signature = _name(func, args)
+        Trace.start(name)
+        Trace.add("signature", signature)
+        if description and description != "":
+            Trace.add("description", description)
+
+        inputs = _inputs(func, args, kwargs)
+        Trace.add("inputs", inputs)
+
+        result = await func(*args, **kwargs)
+        Trace.add("result", _results(result))
+
+        Trace.end()
+
+        return result
+    
+    return wrapper
+
+def trace(func: Callable = None, *, description: str = None) -> Callable:
+    if func is None:
+        return partial(trace, description=description)
+    
+    wrapped_method = (
+        _trace_async if inspect.iscoroutinefunction(func) else _trace_sync
+    )
+
+    return wrapped_method(func, description=description)
+
+
+class PromptyTracer(Tracer):
+    _stack: List[Dict[str, Any]] = []
+    _name: str = None
+
+    def __init__(self, output_dir: str = None) -> None:
+        super().__init__()
+        if output_dir:
+            self.root = Path(output_dir).resolve().absolute()
+        else:
+            self.root = Path(Path(os.getcwd()) / ".runs").resolve().absolute()
+
+        if not self.root.exists():
+            self.root.mkdir(parents=True, exist_ok=True)
+
+    def start(self, name: str) -> None:
+        self._stack.append({"name": name})
+        # first entry frame
+        if self._name is None:
+            self._name = name
+
+    def add(self, name: str, value: Any) -> None:
+        frame = self._stack[-1]
+        if name not in frame:
+            frame[name] = value
+        # multiple values creates list
+        else:
+            if isinstance(frame[name], list):
+                frame[name].append(value)
+            else:
+                frame[name] = [frame[name], value]
+
+
+    def end(self) -> None:
+        # pop the current stack
+        frame = self._stack.pop()
+
+        # if stack is empty, dump the frame
+        if len(self._stack) == 0:
+            self.flush(frame)
+        # otherwise, append the frame to the parent
+        else:
+            if "__frames" not in self._stack[-1]:
+                self._stack[-1]["__frames"] = []
+            self._stack[-1]["__frames"].append(frame)
+
+    def flush(self, frame: Dict[str, Any]) -> None:
+        
+        trace_file = (
+            self.root / f"{self._name}.{datetime.now().strftime('%Y%m%d.%H%M%S')}.ptrace"
+        )
+        
+        with open(trace_file, "w") as f:
+            json.dump(frame, f, indent=4)

prompty-0.1.8.dist-info/METADATA

@@ -0,0 +1,136 @@
+Metadata-Version: 2.1
+Name: prompty
+Version: 0.1.8
+Summary: Prompty is a new asset class and format for LLM prompts that aims to provide observability, understandability, and portability for developers. It includes spec, tooling, and a runtime. This Prompty runtime supports Python
+Author-Email: Seth Juarez <seth.juarez@microsoft.com>
+License: MIT
+Requires-Python: >=3.9
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: pydantic>=2.8.2
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: openai>=1.35.10
+Requires-Dist: azure-identity>=1.17.1
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: click>=8.1.7
+Description-Content-Type: text/markdown
+
+
+Prompty is an asset class and format for LLM prompts designed to enhance observability, understandability, and portability for developers. The primary goal is to accelerate the developer inner loop of prompt engineering and prompt source management in a cross-language and cross-platform implentation.
+
+The file format has a supporting toolchain with a VS Code extension and runtimes in multiple programming languages to simplify and accelerate your AI application development.
+
+The tooling comes together in three ways: the *prompty file asset*, the *VS Code extension tool*, and *runtimes* in multiple programming languges.
+
+## The Prompty File Format
+Prompty is a language agnostic prompt asset for creating prompts and engineering the responses. Learn more about the format [here](https://prompty.ai/docs/prompty-file-spec).
+
+Examples prompty file:
+```markdown
+---
+name: Basic Prompt
+description: A basic prompt that uses the GPT-3 chat API to answer questions
+authors:
+  - sethjuarez
+  - jietong
+model:
+  api: chat
+  configuration:
+    azure_deployment: gpt-35-turbo
+sample:
+  firstName: Jane
+  lastName: Doe
+  question: What is the meaning of life?
+---
+system:
+You are an AI assistant who helps people find information.
+As the assistant, you answer questions briefly, succinctly, 
+and in a personable manner using markdown and even add some personal flair with appropriate emojis.
+
+# Customer
+You are helping {{firstName}} {{lastName}} to find answers to their questions.
+Use their name to address them in your responses.
+
+user:
+{{question}}
+```
+
+
+## The Prompty VS Code Extension
+Run Prompty files directly in VS Code. This Visual Studio Code extension offers an intuitive prompt playground within VS Code to streamline the prompt engineering process. You can find the Prompty extension in the Visual Studio Code Marketplace.
+
+Download the [VS Code extension here](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.prompty).
+
+
+## Using this Prompty Runtime
+The Python runtime is a simple way to run your prompts in Python. The runtime is available as a Python package and can be installed using pip.
+
+```bash
+pip install prompty
+```
+
+Simple usage example:
+
+```python
+import prompty
+
+# execute the prompt
+response = prompty.execute("path/to/prompty/file")
+
+print(response)
+```
+
+## Using Tracing in Prompty
+Prompty supports tracing to help you understand the execution of your prompts. The built-in tracing dumps the execution of the prompt to a file. 
+
+```python
+import prompty
+from prompty.tracer import Trace, PromptyTracer
+
+# add default tracer
+Trace.add_tracerTrace.add_tracer("prompty", PromptyTracer("path/to/trace/dir"))
+
+# execute the prompt
+response = prompty.execute("path/to/prompty/file")
+
+print(response)
+```
+
+You can also bring your own tracer by creating a `Tracer` class. 
+Simple example:
+
+```python
+import prompty
+from prompty.tracer import Tracer
+
+class MyTracer(Tracer):
+
+    def start(self, name: str) -> None:
+        print(f"Starting {name}")
+
+    def add(self, key: str, value: Any) -> None:
+        print(f"Adding {key} with value {value}")
+
+    def end(self) -> None:
+        print("Ending")
+
+# add your tracer
+Trace.add_tracer("my_tracer", MyTracer())
+
+# execute the prompt
+response = prompty.execute("path/to/prompty/file")
+
+```
+
+To define your own tracer, you can subclass the `Tracer` class and implement the `start`, `add`, and `end` methods and then add it to the `Trace` instance. You can add as many tracers as you like - the will all of them will be called in order.
+
+## CLI
+The Prompty runtime also comes with a CLI tool that allows you to run prompts from the command line. The CLI tool is installed with the Python package.
+
+```bash
+prompty -s path/to/prompty/file
+```
+
+This will execute the prompt and print the response to the console. It also has default tracing enabled.
+
+## Contributing
+We welcome contributions to the Prompty project! This community led project is open to all contributors. The project cvan be found on [GitHub](https://github.com/Microsoft/prompty).

prompty-0.1.8.dist-info/RECORD

@@ -0,0 +1,12 @@
+prompty-0.1.8.dist-info/METADATA,sha256=1sVPpxf3pjHAhCIJoXa-v02zF6P5w4aCdBcQZV3kEm4,4665
+prompty-0.1.8.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
+prompty-0.1.8.dist-info/licenses/LICENSE,sha256=KWSC4z9cfML_t0xThoQYjzTdcZQj86Y_mhXdatzU-KM,1052
+prompty/__init__.py,sha256=Msp8eiKdrDq0wyl6G5DFDH8r5BxM2_E60uzzL7_MJ5w,11183
+prompty/cli.py,sha256=_bx_l5v7OGhtAn4d_73b8tyfEw7OOkjCqGMQPu0YP5A,2489
+prompty/core.py,sha256=WYSvognjMUl08FT0_mkcqZfymb_guKcp3sK8_RO4Kq0,13528
+prompty/executors.py,sha256=TankDTAEBTZkvnPfNUw2KNb1TnNuWhyY8TkWOogUXKs,3185
+prompty/parsers.py,sha256=4mmIn4SVNs8B0R1BufanqUJk8v4r0OEEo8yx6UOxQpA,4670
+prompty/processors.py,sha256=GmReygLx2XW1UuanlX71HG3rTZL86y0yAGyNdbGWkcg,2366
+prompty/renderers.py,sha256=RSHFQFx7AtKLUfsMLCXR0a56Mb7DL1NJNgjUqgg3IqU,776
+prompty/tracer.py,sha256=XMS4aJD_Tp76wm2UFB8amtXn7ioGmPBUy11LmklSUFQ,6490
+prompty-0.1.8.dist-info/RECORD,,

{prompty-0.1.1.dist-info → prompty-0.1.8.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.3.2)
+Generator: pdm-backend (2.3.3)
 Root-Is-Purelib: true
 Tag: py3-none-any

prompty-0.1.8.dist-info/licenses/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Microsoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

prompty-0.1.1.dist-info/METADATA

@@ -1,15 +0,0 @@
-Metadata-Version: 2.1
-Name: prompty
-Version: 0.1.1
-Summary: Prompty is a new asset class and format for LLM prompts that aims to provide observability, understandability, and portability for developers. It includes spec, tooling, and a runtime. This Prompty runtime supports Python
-Author-Email: Seth Juarez <seth.juarez@microsoft.com>
-License: MIT
-Requires-Python: >=3.9
-Requires-Dist: pyyaml>=6.0.1
-Requires-Dist: pydantic>=2.8.2
-Requires-Dist: jinja2>=3.1.4
-Requires-Dist: openai>=1.35.10
-Requires-Dist: azure-identity>=1.17.1
-Description-Content-Type: text/markdown
-
-# prompty

prompty-0.1.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-prompty-0.1.1.dist-info/METADATA,sha256=fkJx_0VrHNxhOcuQHhgaQSuyevJdErISkPbzA5A2noM,581
-prompty-0.1.1.dist-info/WHEEL,sha256=mbxFTmdEUhG7evcdMkR3aBt9SWcoFBJ4CDwnfguNegA,90
-prompty/__init__.py,sha256=PP7fVje52try-QcjVnSc44MkF8DVYXeCTfbyRlltqZI,7625
-prompty/core.py,sha256=AIQCA-aN9i9tckcObGoRMMS4rjRZzSTSKxM-o6hXuDw,10085
-prompty/executors.py,sha256=KlvlDXxpwNCXNpkvigG_jNcaBTz8eP3pFiVjPPnyjk0,2448
-prompty/parsers.py,sha256=e7Wf4hnDzrcau_4WsaQT9Jeqcuf1gYvL4KERCnWnVXQ,3993
-prompty/processors.py,sha256=x3LCtXhElsaa6bJ82-x_QFNpc7ddgDcyimcNOtni-ow,1856
-prompty/renderers.py,sha256=-NetGbPujfRLgofsbU8ty7Ap-y4oFb47bqE21I-vx8o,745
-prompty-0.1.1.dist-info/RECORD,,