agenta 0.5.2__tar.gz → 0.5.4__tar.gz

{agenta-0.5.2 → agenta-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: agenta
-Version: 0.5.2
+Version: 0.5.4
 Summary: The SDK for agenta is an open-source LLMOps platform.
 Home-page: https://agenta.ai
 Keywords: LLMOps,LLM,evaluation,prompt engineering
@@ -19,6 +19,7 @@ Requires-Dist: docker (>=6.1.1,<7.0.0)
 Requires-Dist: fastapi (>=0.95.1,<0.96.0)
 Requires-Dist: importlib-metadata (>=6.7.0,<7.0.0)
 Requires-Dist: ipdb (>=0.13.13,<0.14.0)
+Requires-Dist: posthog (>=3.0.2,<4.0.0)
 Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
 Requires-Dist: python-multipart (>=0.0.6,<0.0.7)
 Requires-Dist: questionary (>=1.10.0,<2.0.0)

agenta-0.5.4/agenta/cli/helper.py

@@ -0,0 +1,185 @@
+import sys
+import toml
+import click
+import questionary
+from pathlib import Path
+from agenta.client import client
+from typing import Any, List, MutableMapping
+from agenta.client.api_models import AppVariant
+
+
+from typing import Any, Optional
+from pathlib import Path
+import toml
+
+
+def get_global_config(var_name: str) -> Optional[Any]:
+    """
+    Get the value of a global configuration variable.
+
+    Args:
+        var_name: the name of the variable to get
+
+    Returns:
+        the value of the variable, or None if it doesn't exist
+    """
+    agenta_dir = Path.home() / ".agenta"
+    if not agenta_dir.exists():
+        return None
+    agenta_config_file = agenta_dir / "config.toml"
+    if not agenta_config_file.exists():
+        return None
+    global_config = toml.load(agenta_config_file)
+    if var_name not in global_config:
+        return None
+    return global_config[var_name]
+
+
+def set_global_config(var_name: str, var_value: Any) -> None:
+    """
+    Set the value of a global configuration variable.
+
+    Args:
+        var_name: the name of the variable to set
+        var_value: the value to set the variable to
+    """
+    agenta_dir = Path.home() / ".agenta"
+    if not agenta_dir.exists():
+        agenta_dir.mkdir(exist_ok=True)
+    agenta_config_file = agenta_dir / "config.toml"
+    if not agenta_config_file.exists():
+        config = {}
+        with agenta_config_file.open("w") as config_file:
+            toml.dump(config, config_file)
+    global_config = toml.load(agenta_config_file)
+    global_config[var_name] = var_value
+    with open(agenta_config_file, "w") as config_file:
+        toml.dump(global_config, config_file)
+
+
+def get_api_key() -> str:
+    """
+    Retrieve or request the API key for accessing the Agenta platform.
+
+    This function first looks for an existing API key in the global config file.
+    If found, it prompts the user to confirm whether they'd like to use that key.
+    If not found, it asks the user to input a new key.
+
+    Returns:
+        str: The API key to be used for accessing the Agenta platform.
+
+    Raises:
+        SystemExit: If the user cancels the input by pressing Ctrl+C.
+    """
+
+    api_key = get_global_config("api_key")
+    if api_key:
+        # API key exists in the config file, ask for confirmation
+        confirm_api_key = questionary.confirm(
+            f"API Key found: {api_key}\nDo you want to use this API Key?"
+        ).ask()
+
+        if confirm_api_key:
+            return api_key
+        elif confirm_api_key is None:  # User pressed Ctrl+C
+            sys.exit(0)
+    else:
+        api_key = questionary.text(
+            "(You can get your API Key here: https://demo.agenta.ai/settings?tab=apiKeys) "
+            "Please provide your API key:"
+        ).ask()
+
+        if api_key:
+            set_global_config("api_key", api_key)
+        elif api_key is None:  # User pressed Ctrl+C
+            sys.exit(0)
+
+
+def init_telemetry_config() -> None:
+    if (
+        get_global_config("telemetry_tracking_enabled") is None
+        or get_global_config("telemetry_api_key") is None
+    ):
+        set_global_config("telemetry_tracking_enabled", True)
+        set_global_config(
+            "telemetry_api_key", "phc_hmVSxIjTW1REBHXgj2aw4HW9X6CXb6FzerBgP9XenC7"
+        )
+
+
+def update_variants_from_backend(
+    app_id: str,
+    config: MutableMapping[str, Any],
+    host: str,
+    api_key: str = None,
+) -> MutableMapping[str, Any]:
+    """Reads the list of variants from the backend and updates the config accordingly
+
+    Arguments:
+        app_id -- the app id
+        config -- the config loaded using toml.load
+        api_key -- the api key to use for authentication
+
+    Returns:
+        a new config object later to be saved using toml.dump(config, config_file.open('w'))
+    """
+
+    try:
+        variants: List[AppVariant] = client.list_variants(app_id, host, api_key)
+    except Exception as ex:
+        raise ex
+
+    config["variants"] = [variant.variant_name for variant in variants]
+    config["variant_ids"] = [variant.variant_id for variant in variants]
+    return config
+
+
+def update_config_from_backend(config_file: Path, host: str):
+    """Updates the config file with new information from the backend
+
+    Arguments:
+        config_file -- the path to the config file
+    """
+    assert config_file.exists(), "Config file does not exist!"
+    config = toml.load(config_file)
+    app_id = config["app_id"]
+    api_key = config.get("api_key", None)
+    if "variants" not in config:
+        config["variants"] = []
+    if "variant_ids" not in config:
+        config["variant_ids"] = []
+    config = update_variants_from_backend(app_id, config, host, api_key)
+    toml.dump(config, config_file.open("w"))
+
+
+def display_app_variant(variant: AppVariant):
+    """Prints a variant nicely in the terminal"""
+    click.echo(
+        click.style("App Name: ", bold=True, fg="green")
+        + click.style(variant.app_name, fg="green")
+    )
+    click.echo(
+        click.style("Variant Name: ", bold=True, fg="blue")
+        + click.style(variant.variant_name, fg="blue")
+    )
+    click.echo(click.style("Parameters: ", bold=True, fg="cyan"))
+    if variant.parameters:
+        for param, value in variant.parameters.items():
+            click.echo(
+                click.style(f"  {param}: ", fg="cyan")
+                + click.style(str(value), fg="cyan")
+            )
+    else:
+        click.echo(click.style("  Defaults from code", fg="cyan"))
+    if variant.previous_variant_name:
+        click.echo(
+            click.style("Template Variant Name: ", bold=True, fg="magenta")
+            + click.style(variant.previous_variant_name, fg="magenta")
+        )
+    else:
+        click.echo(
+            click.style("Template Variant Name: ", bold=True, fg="magenta")
+            + click.style("None", fg="magenta")
+        )
+    click.echo(
+        click.style("-" * 50, bold=True, fg="white")
+    )  # a line for separating each variant

agenta-0.5.4/agenta/cli/telemetry.py

@@ -0,0 +1,48 @@
+# Stdlib Imports
+import toml
+from pathlib import Path
+
+# Own Imports
+from agenta.cli import helper
+
+# Third party Imports
+from posthog import Posthog
+
+
+# Load telemetry configuration
+helper.init_telemetry_config()
+
+
+class EventTracking(Posthog):
+    _instance = None
+
+    def __new__(cls, *args, **kwargs):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+        return cls._instance
+
+    def __init__(self, api_key: str, host: str) -> None:
+        super(Posthog, self).__init__(api_key, host)
+
+    def capture_event(
+        self,
+        distinct_id: str,
+        event_name: str,
+        body: dict,
+    ) -> None:
+        """
+        Captures an event.
+
+        Args:
+            distinct_id (str): A unique identifier for the user or entity associated with the event.
+            event_name (str): The name of the event being captured.
+            body (dict): Contains the data associated with the event being captured.
+        """
+
+        self.capture(distinct_id, event_name, body)
+
+
+# Initialize event tracking
+event_track = EventTracking(
+    helper.get_global_config("telemetry_api_key"), "https://app.posthog.com"
+)

{agenta-0.5.2 → agenta-0.5.4}/agenta/cli/variant_commands.py

@@ -1,7 +1,7 @@
 import re
 import sys
-from pathlib import Path
 from typing import List
+from pathlib import Path
 
 from requests.exceptions import ConnectionError
 
@@ -10,12 +10,9 @@ import questionary
 import toml
 from agenta.cli import helper
 from agenta.client import client
+from agenta.cli.telemetry import event_track
 from agenta.client.api_models import AppVariant, Image
-from agenta.docker.docker_utils import (
-    build_and_upload_docker_image,
-    build_tar_docker_container,
-)
-from docker.models.images import Image as DockerImage
+from agenta.docker.docker_utils import build_tar_docker_container
 
 
 @click.group()
@@ -44,12 +41,15 @@ def add_variant(
     app_path = Path(app_folder)
     config_file = app_path / "config.toml"
     config = toml.load(config_file)
+
     app_name = config["app_name"]
     app_id = config["app_id"]
     api_key = config.get("api_key", None)
-    base_name = file_name.removesuffix(".py")
+
     config_name = "default"
+    base_name = file_name.removesuffix(".py")
     variant_name = f"{base_name}.{config_name}"
+
     # check files in folder
     app_file = app_path / file_name
     if not app_file.exists():
@@ -104,7 +104,8 @@ def add_variant(
     try:
         click.echo(
             click.style(
-                f"Preparing code base {base_name} into a tar file...", fg="bright_black"
+                f"Preparing code base {base_name} into a tar file...",
+                fg="bright_black",
             )
         )
         tar_path = build_tar_docker_container(folder=app_path, file_name=file_name)
@@ -149,7 +150,25 @@ def add_variant(
         else:
             click.echo(click.style(f"Error while adding variant: {ex}", fg="red"))
         return None
+
+    agenta_dir = Path.home() / ".agenta"
+    global_toml_file = toml.load(agenta_dir / "config.toml")
+    tracking_enabled: bool = global_toml_file["telemetry_tracking_enabled"]
     if overwrite:
+        # Track a deployment event
+        if tracking_enabled:
+            user_id = client.retrieve_user_id(host, api_key)
+            event_track.capture_event(
+                user_id,
+                "app_deployment",
+                body={
+                    "app_id": app_id,
+                    "deployed_by": user_id,
+                    "environment": "CLI",
+                    "version": "cloud" if api_key else "oss",
+                },
+            )
+
         click.echo(
             click.style(
                 f"Variant {variant_name} for App {app_name} updated successfully 🎉",
@@ -158,6 +177,20 @@ def add_variant(
             )
         )
     else:
+        # Track a deployment event
+        if tracking_enabled:
+            user_id = client.retrieve_user_id(host, api_key)
+            event_track.capture_event(
+                user_id,
+                "app_deployment",
+                body={
+                    "app_id": app_id,
+                    "deployed_by": user_id,
+                    "environment": "CLI",
+                    "version": "cloud" if api_key else "oss",
+                },
+            )
+
         click.echo(
             click.style(
                 f"Variant {variant_name} for App {app_name} added successfully to Agenta!",
@@ -184,7 +217,6 @@ def start_variant(variant_id: str, app_folder: str, host: str):
     app_folder = Path(app_folder)
     config_file = app_folder / "config.toml"
     config = toml.load(config_file)
-    app_name = config["app_name"]
     api_key = config.get("api_key", None)
     app_id = config["app_id"]
 

{agenta-0.5.2 → agenta-0.5.4}/agenta/client/client.py

@@ -463,3 +463,30 @@ def validate_api_key(api_key: str, host: str) -> bool:
         return True
     except RequestException as e:
         raise APIRequestError(f"An error occurred while making the request: {e}")
+
+
+def retrieve_user_id(host: str, api_key: Optional[str] = None) -> str:
+    """Retrieve user ID from the server.
+
+    Args:
+        host (str): The URL of the Agenta backend
+        api_key (str): The API key to validate with.
+
+    Returns:
+        str: the user ID
+    """
+
+    try:
+        response = requests.get(
+            f"{host}/{BACKEND_URL_SUFFIX}/profile/",
+            headers={"Authorization": api_key} if api_key is not None else None,
+            timeout=600,
+        )
+        if response.status_code != 200:
+            error_message = response.json().get("detail", "Unknown error")
+            raise APIRequestError(
+                f"Request to fetch_user_profile endpoint failed with status code {response.status_code}. Error message: {error_message}"
+            )
+        return response.json()["id"]
+    except RequestException as e:
+        raise APIRequestError(f"Request failed: {str(e)}")

{agenta-0.5.2 → agenta-0.5.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "agenta"
-version = "0.5.2"
+version = "0.5.4"
 description = "The SDK for agenta is an open-source LLMOps platform."
 readme = "README.md"
 authors = ["Mahmoud Mabrouk <mahmoud@agenta.ai>"]
@@ -26,6 +26,7 @@ ipdb = "^0.13.13"
 python-dotenv = "^1.0.0"
 python-multipart = "^0.0.6"
 importlib-metadata = "^6.7.0"
+posthog = "^3.0.2"
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2"

agenta-0.5.2/agenta/cli/helper.py

@@ -1,118 +0,0 @@
-import sys
-import toml
-import click
-import questionary
-from pathlib import Path
-from agenta.client import client
-from typing import Any, List, MutableMapping
-from agenta.client.api_models import AppVariant
-
-
-def get_api_key():
-    agenta_dir = Path.home() / ".agenta"
-    agenta_dir.mkdir(exist_ok=True)
-    credentials_file = agenta_dir / "config.toml"
-
-    if credentials_file.exists():
-        config = toml.load(credentials_file)
-        api_key = config.get("api_key", None)
-
-        if api_key:
-            # API key exists in the config file, ask for confirmation
-            confirm_api_key = questionary.confirm(
-                f"API Key found: {api_key}\nDo you want to use this API Key?"
-            ).ask()
-
-            if confirm_api_key:
-                return api_key
-            elif confirm_api_key is None:  # User pressed Ctrl+C
-                sys.exit(0)
-
-    api_key = questionary.text(
-        "(You can get your API Key here: https://demo.agenta.ai/settings?tab=apiKeys) Please provide your API key:"
-    ).ask()
-
-    if api_key:
-        config = {"api_key": api_key}
-        with open(credentials_file, "w") as config_file:
-            toml.dump(config, config_file)
-
-        return api_key
-    elif api_key is None:  # User pressed Ctrl+C
-        sys.exit(0)
-
-
-def update_variants_from_backend(
-    app_id: str, config: MutableMapping[str, Any], host: str, api_key: str = None
-) -> MutableMapping[str, Any]:
-    """Reads the list of variants from the backend and updates the config accordingly
-
-    Arguments:
-        app_id -- the app id
-        config -- the config loaded using toml.load
-        api_key -- the api key to use for authentication
-
-    Returns:
-        a new config object later to be saved using toml.dump(config, config_file.open('w'))
-    """
-
-    try:
-        variants: List[AppVariant] = client.list_variants(app_id, host, api_key)
-    except Exception as ex:
-        raise ex
-
-    config["variants"] = [variant.variant_name for variant in variants]
-    config["variant_ids"] = [variant.variant_id for variant in variants]
-    return config
-
-
-def update_config_from_backend(config_file: Path, host: str):
-    """Updates the config file with new information from the backend
-
-    Arguments:
-        config_file -- the path to the config file
-    """
-    assert config_file.exists(), "Config file does not exist!"
-    config = toml.load(config_file)
-    app_id = config["app_id"]
-    api_key = config.get("api_key", None)
-    if "variants" not in config:
-        config["variants"] = []
-    if "variant_ids" not in config:
-        config["variant_ids"] = []
-    config = update_variants_from_backend(app_id, config, host, api_key)
-    toml.dump(config, config_file.open("w"))
-
-
-def display_app_variant(variant: AppVariant):
-    """Prints a variant nicely in the terminal"""
-    click.echo(
-        click.style("App Name: ", bold=True, fg="green")
-        + click.style(variant.app_name, fg="green")
-    )
-    click.echo(
-        click.style("Variant Name: ", bold=True, fg="blue")
-        + click.style(variant.variant_name, fg="blue")
-    )
-    click.echo(click.style("Parameters: ", bold=True, fg="cyan"))
-    if variant.parameters:
-        for param, value in variant.parameters.items():
-            click.echo(
-                click.style(f"  {param}: ", fg="cyan")
-                + click.style(str(value), fg="cyan")
-            )
-    else:
-        click.echo(click.style("  Defaults from code", fg="cyan"))
-    if variant.previous_variant_name:
-        click.echo(
-            click.style("Template Variant Name: ", bold=True, fg="magenta")
-            + click.style(variant.previous_variant_name, fg="magenta")
-        )
-    else:
-        click.echo(
-            click.style("Template Variant Name: ", bold=True, fg="magenta")
-            + click.style("None", fg="magenta")
-        )
-    click.echo(
-        click.style("-" * 50, bold=True, fg="white")
-    )  # a line for separating each variant