honeycomb-api 0.1.0__py3-none-any.whl → 0.5.3__py3-none-any.whl

honeycomb/_generated/models/webhook_recipient.py

@@ -1,16 +1,13 @@
-from typing import Any, TypeVar, Optional, BinaryIO, TextIO, TYPE_CHECKING
+import datetime
+from typing import (TYPE_CHECKING, Any, BinaryIO, Optional, TextIO, TypeVar,
+                    Union, cast)
 
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
-
-from ..types import UNSET, Unset
+from dateutil.parser import isoparse
 
 from ..models.webhook_recipient_type import WebhookRecipientType
 from ..types import UNSET, Unset
-from dateutil.parser import isoparse
-from typing import cast
-from typing import Union
-import datetime
 
 if TYPE_CHECKING:
   from ..models.webhook_recipient_details import WebhookRecipientDetails

honeycomb/_generated/models/webhook_recipient_details.py

@@ -1,17 +1,15 @@
-from typing import Any, TypeVar, Optional, BinaryIO, TextIO, TYPE_CHECKING
+from typing import (TYPE_CHECKING, Any, BinaryIO, Optional, TextIO, TypeVar,
+                    Union, cast)
 
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
 from ..types import UNSET, Unset
 
-from ..types import UNSET, Unset
-from typing import cast
-from typing import Union
-
 if TYPE_CHECKING:
   from ..models.webhook_header import WebhookHeader
-  from ..models.webhook_recipient_details_webhook_payloads import WebhookRecipientDetailsWebhookPayloads
+  from ..models.webhook_recipient_details_webhook_payloads import \
+      WebhookRecipientDetailsWebhookPayloads
 
 
 
@@ -44,7 +42,8 @@ class WebhookRecipientDetails:
 
     def to_dict(self) -> dict[str, Any]:
         from ..models.webhook_header import WebhookHeader
-        from ..models.webhook_recipient_details_webhook_payloads import WebhookRecipientDetailsWebhookPayloads
+        from ..models.webhook_recipient_details_webhook_payloads import \
+            WebhookRecipientDetailsWebhookPayloads
         webhook_name = self.webhook_name
 
         webhook_url = self.webhook_url
@@ -85,7 +84,8 @@ class WebhookRecipientDetails:
     @classmethod
     def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
         from ..models.webhook_header import WebhookHeader
-        from ..models.webhook_recipient_details_webhook_payloads import WebhookRecipientDetailsWebhookPayloads
+        from ..models.webhook_recipient_details_webhook_payloads import \
+            WebhookRecipientDetailsWebhookPayloads
         d = src_dict.copy()
         webhook_name = d.pop("webhook_name")
 

honeycomb/_generated/models/webhook_recipient_details_webhook_payloads.py

@@ -1,17 +1,15 @@
-from typing import Any, TypeVar, Optional, BinaryIO, TextIO, TYPE_CHECKING
+from typing import (TYPE_CHECKING, Any, BinaryIO, Optional, TextIO, TypeVar,
+                    Union, cast)
 
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
 from ..types import UNSET, Unset
 
-from ..types import UNSET, Unset
-from typing import cast
-from typing import Union
-
 if TYPE_CHECKING:
   from ..models.template_variable_definition import TemplateVariableDefinition
-  from ..models.webhook_recipient_details_webhook_payloads_payload_templates import WebhookRecipientDetailsWebhookPayloadsPayloadTemplates
+  from ..models.webhook_recipient_details_webhook_payloads_payload_templates import \
+      WebhookRecipientDetailsWebhookPayloadsPayloadTemplates
 
 
 
@@ -37,8 +35,10 @@ class WebhookRecipientDetailsWebhookPayloads:
 
 
     def to_dict(self) -> dict[str, Any]:
-        from ..models.template_variable_definition import TemplateVariableDefinition
-        from ..models.webhook_recipient_details_webhook_payloads_payload_templates import WebhookRecipientDetailsWebhookPayloadsPayloadTemplates
+        from ..models.template_variable_definition import \
+            TemplateVariableDefinition
+        from ..models.webhook_recipient_details_webhook_payloads_payload_templates import \
+            WebhookRecipientDetailsWebhookPayloadsPayloadTemplates
         template_variables: Union[Unset, list[dict[str, Any]]] = UNSET
         if not isinstance(self.template_variables, Unset):
             template_variables = []
@@ -68,8 +68,10 @@ class WebhookRecipientDetailsWebhookPayloads:
 
     @classmethod
     def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
-        from ..models.template_variable_definition import TemplateVariableDefinition
-        from ..models.webhook_recipient_details_webhook_payloads_payload_templates import WebhookRecipientDetailsWebhookPayloadsPayloadTemplates
+        from ..models.template_variable_definition import \
+            TemplateVariableDefinition
+        from ..models.webhook_recipient_details_webhook_payloads_payload_templates import \
+            WebhookRecipientDetailsWebhookPayloadsPayloadTemplates
         d = src_dict.copy()
         template_variables = []
         _template_variables = d.pop("template_variables", UNSET)

honeycomb/_generated/models/webhook_recipient_details_webhook_payloads_payload_templates.py

@@ -1,14 +1,11 @@
-from typing import Any, TypeVar, Optional, BinaryIO, TextIO, TYPE_CHECKING
+from typing import (TYPE_CHECKING, Any, BinaryIO, Optional, TextIO, TypeVar,
+                    Union, cast)
 
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
 from ..types import UNSET, Unset
 
-from ..types import UNSET, Unset
-from typing import cast
-from typing import Union
-
 if TYPE_CHECKING:
   from ..models.payload_template import PayloadTemplate
 

honeycomb/_generated/models/webhook_recipient_type.py

@@ -1,5 +1,6 @@
 from enum import Enum
 
+
 class WebhookRecipientType(str, Enum):
     WEBHOOK = "webhook"
 

honeycomb/_generated/types.py

@@ -2,7 +2,7 @@
 
 from collections.abc import MutableMapping
 from http import HTTPStatus
-from typing import BinaryIO, Generic, Optional, TypeVar, Literal
+from typing import BinaryIO, Generic, Literal, Optional, TypeVar
 
 from attrs import define
 

honeycomb/cli/__init__.py

@@ -0,0 +1,85 @@
+"""
+CLI for Honeycomb API operations.
+
+Provides commands for managing triggers, SLOs, boards, queries, datasets,
+markers, recipients, and derived columns.
+"""
+
+import typer
+from rich.console import Console
+
+app = typer.Typer(
+    name="honeycomb",
+    help="CLI for Honeycomb.io API operations",
+    no_args_is_help=True,
+)
+console = Console()
+
+
+# Import and register subcommands
+# These imports are deferred to avoid circular dependencies
+def _register_commands() -> None:
+    """Register all CLI subcommands."""
+    from honeycomb.cli import (
+        api_keys,
+        auth,
+        boards,
+        columns,
+        config,
+        datasets,
+        derived_columns,
+        environments,
+        markers,
+        queries,
+        recipients,
+        slos,
+        triggers,
+    )
+
+    # we can't do real aliases because Typer doesn't support them
+    # but watch this PR: https://github.com/fastapi/typer/pull/1422
+    app.add_typer(triggers.app, name="triggers")
+    app.add_typer(triggers.app, name="trigger", hidden=True)
+    app.add_typer(triggers.app, name="t", hidden=True)
+    app.add_typer(slos.app, name="slos")
+    app.add_typer(slos.app, name="slo", hidden=True)
+    app.add_typer(slos.app, name="s", hidden=True)
+    app.add_typer(boards.app, name="boards")
+    app.add_typer(boards.app, name="board", hidden=True)
+    app.add_typer(boards.app, name="b", hidden=True)
+    app.add_typer(columns.app, name="columns")
+    app.add_typer(columns.app, name="column", hidden=True)
+    app.add_typer(columns.app, name="c", hidden=True)
+    app.add_typer(queries.app, name="queries")
+    app.add_typer(queries.app, name="query", hidden=True)
+    app.add_typer(queries.app, name="q", hidden=True)
+    app.add_typer(datasets.app, name="datasets")
+    app.add_typer(datasets.app, name="dataset", hidden=True)
+    app.add_typer(datasets.app, name="d", hidden=True)
+    app.add_typer(markers.app, name="markers")
+    app.add_typer(markers.app, name="marker", hidden=True)
+    app.add_typer(markers.app, name="m", hidden=True)
+    app.add_typer(recipients.app, name="recipients")
+    app.add_typer(recipients.app, name="recipient", hidden=True)
+    app.add_typer(recipients.app, name="r", hidden=True)
+    app.add_typer(derived_columns.app, name="derived-columns")
+    app.add_typer(derived_columns.app, name="derived-column", hidden=True)
+    app.add_typer(derived_columns.app, name="dc", hidden=True)
+    app.add_typer(derived_columns.app, name="calculated-fields", hidden=True)
+    app.add_typer(derived_columns.app, name="calculated-field", hidden=True)
+    app.add_typer(derived_columns.app, name="cf", hidden=True)
+    app.add_typer(auth.app, name="auth")
+    app.add_typer(api_keys.app, name="api-keys")
+    app.add_typer(api_keys.app, name="api-key", hidden=True)
+    app.add_typer(api_keys.app, name="a", hidden=True)
+    app.add_typer(environments.app, name="environments")
+    app.add_typer(environments.app, name="environment", hidden=True)
+    app.add_typer(environments.app, name="e", hidden=True)
+    app.add_typer(config.app, name="config")
+    app.add_typer(config.app, name="conf", hidden=True)
+
+
+_register_commands()
+
+if __name__ == "__main__":
+    app()

honeycomb/cli/api_keys.py

@@ -0,0 +1,205 @@
+"""API Keys management commands (v2 team-scoped)."""
+
+import typer
+from rich.console import Console
+
+from honeycomb.cli.config import get_client
+from honeycomb.cli.formatters import DEFAULT_OUTPUT_FORMAT, OutputFormat, output_result
+from honeycomb.models.api_keys import ApiKeyCreate, ApiKeyType
+
+app = typer.Typer(help="Manage API keys (requires management key)")
+console = Console()
+
+
+@app.command("list")
+def list_api_keys(
+    key_type: str | None = typer.Option(
+        None, "--type", help="Filter by type: ingest or configuration"
+    ),
+    profile: str | None = typer.Option(None, "--profile", "-p", help="Config profile to use"),
+    management_key: str | None = typer.Option(
+        None, "--management-key", envvar="HONEYCOMB_MANAGEMENT_KEY"
+    ),
+    management_secret: str | None = typer.Option(
+        None, "--management-secret", envvar="HONEYCOMB_MANAGEMENT_SECRET"
+    ),
+    output: OutputFormat = typer.Option(DEFAULT_OUTPUT_FORMAT, "--output", "-o"),
+) -> None:
+    """List all API keys for your authenticated team.
+
+    Examples:
+        # List all API keys
+        hny api-keys list
+
+        # Filter by type
+        hny api-keys list --type ingest
+    """
+    try:
+        client = get_client(
+            profile=profile,
+            management_key=management_key,
+            management_secret=management_secret,
+        )
+
+        keys = client.api_keys.list(key_type=key_type)
+        output_result(keys, output)
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}", style="bold")
+        raise typer.Exit(1)
+
+
+@app.command("get")
+def get_api_key(
+    key_id: str = typer.Argument(..., help="API key ID"),
+    profile: str | None = typer.Option(None, "--profile", "-p", help="Config profile to use"),
+    management_key: str | None = typer.Option(
+        None, "--management-key", envvar="HONEYCOMB_MANAGEMENT_KEY"
+    ),
+    management_secret: str | None = typer.Option(
+        None, "--management-secret", envvar="HONEYCOMB_MANAGEMENT_SECRET"
+    ),
+    output: OutputFormat = typer.Option(DEFAULT_OUTPUT_FORMAT, "--output", "-o"),
+) -> None:
+    """Get a specific API key by ID for your authenticated team.
+
+    Examples:
+        hny api-keys get hcaik_123
+    """
+    try:
+        client = get_client(
+            profile=profile,
+            management_key=management_key,
+            management_secret=management_secret,
+        )
+
+        key = client.api_keys.get(key_id=key_id)
+        output_result(key, output)
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}", style="bold")
+        raise typer.Exit(1)
+
+
+@app.command("create")
+def create_api_key(
+    name: str = typer.Option(..., "--name", help="API key name"),
+    key_type: ApiKeyType = typer.Option(..., "--type", help="Key type: ingest or configuration"),
+    environment_id: str = typer.Option(..., "--environment", "-e", help="Environment ID"),
+    profile: str | None = typer.Option(None, "--profile", "-p", help="Config profile to use"),
+    management_key: str | None = typer.Option(
+        None, "--management-key", envvar="HONEYCOMB_MANAGEMENT_KEY"
+    ),
+    management_secret: str | None = typer.Option(
+        None, "--management-secret", envvar="HONEYCOMB_MANAGEMENT_SECRET"
+    ),
+    output: OutputFormat = typer.Option(DEFAULT_OUTPUT_FORMAT, "--output", "-o"),
+) -> None:
+    """Create a new API key for your authenticated team.
+
+    Examples:
+        hny api-keys create --name "My Key" --type ingest --environment env-123
+    """
+    try:
+        client = get_client(
+            profile=profile,
+            management_key=management_key,
+            management_secret=management_secret,
+        )
+
+        api_key = ApiKeyCreate(
+            name=name,
+            key_type=key_type,
+            environment_id=environment_id,
+        )
+
+        created = client.api_keys.create(api_key=api_key)
+        output_result(created, output)
+
+        # Warn about secret
+        if created.secret and output == OutputFormat.table:
+            console.print(
+                "\n[yellow]Warning:[/yellow] The secret is only shown once. Save it securely!",
+                style="bold",
+            )
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}", style="bold")
+        raise typer.Exit(1)
+
+
+@app.command("update")
+def update_api_key(
+    key_id: str = typer.Argument(..., help="API key ID"),
+    name: str | None = typer.Option(None, "--name", help="New name"),
+    disabled: bool | None = typer.Option(None, "--disabled", help="Disable the key"),
+    profile: str | None = typer.Option(None, "--profile", "-p", help="Config profile to use"),
+    management_key: str | None = typer.Option(
+        None, "--management-key", envvar="HONEYCOMB_MANAGEMENT_KEY"
+    ),
+    management_secret: str | None = typer.Option(
+        None, "--management-secret", envvar="HONEYCOMB_MANAGEMENT_SECRET"
+    ),
+    output: OutputFormat = typer.Option(DEFAULT_OUTPUT_FORMAT, "--output", "-o"),
+) -> None:
+    """Update an API key for your authenticated team.
+
+    Examples:
+        hny api-keys update hcaik_123 --name "New Name"
+        hny api-keys update hcaik_123 --disabled
+    """
+    try:
+        from honeycomb.models.api_keys import ApiKeyUpdate
+
+        client = get_client(
+            profile=profile,
+            management_key=management_key,
+            management_secret=management_secret,
+        )
+
+        update = ApiKeyUpdate(name=name, disabled=disabled)
+        updated = client.api_keys.update(key_id=key_id, api_key=update)
+        output_result(updated, output)
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}", style="bold")
+        raise typer.Exit(1)
+
+
+@app.command("delete")
+def delete_api_key(
+    key_id: str = typer.Argument(..., help="API key ID"),
+    profile: str | None = typer.Option(None, "--profile", "-p", help="Config profile to use"),
+    management_key: str | None = typer.Option(
+        None, "--management-key", envvar="HONEYCOMB_MANAGEMENT_KEY"
+    ),
+    management_secret: str | None = typer.Option(
+        None, "--management-secret", envvar="HONEYCOMB_MANAGEMENT_SECRET"
+    ),
+    yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation"),
+) -> None:
+    """Delete an API key for your authenticated team.
+
+    Examples:
+        hny api-keys delete hcaik_123
+        hny api-keys delete hcaik_123 --yes
+    """
+    try:
+        if not yes:
+            confirm = typer.confirm(f"Delete API key {key_id}?")
+            if not confirm:
+                console.print("Cancelled")
+                raise typer.Exit(0)
+
+        client = get_client(
+            profile=profile,
+            management_key=management_key,
+            management_secret=management_secret,
+        )
+
+        client.api_keys.delete(key_id=key_id)
+        console.print(f"[green]Deleted API key:[/green] {key_id}")
+
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}", style="bold")
+        raise typer.Exit(1)

honeycomb/cli/auth.py

@@ -0,0 +1,70 @@
+"""Authentication information commands."""
+
+import typer
+from rich.console import Console
+
+from honeycomb.cli.config import get_client
+from honeycomb.cli.formatters import DEFAULT_OUTPUT_FORMAT, OutputFormat, output_result
+
+app = typer.Typer(help="Authentication and API key information")
+console = Console()
+
+
+@app.command("get")
+def get_auth(
+    v2: bool = typer.Option(False, "--v2", help="Use v2 endpoint (management key)"),
+    profile: str | None = typer.Option(None, "--profile", "-p", help="Config profile to use"),
+    api_key: str | None = typer.Option(None, "--api-key", envvar="HONEYCOMB_API_KEY"),
+    management_key: str | None = typer.Option(
+        None, "--management-key", envvar="HONEYCOMB_MANAGEMENT_KEY"
+    ),
+    management_secret: str | None = typer.Option(
+        None, "--management-secret", envvar="HONEYCOMB_MANAGEMENT_SECRET"
+    ),
+    output: OutputFormat = typer.Option(DEFAULT_OUTPUT_FORMAT, "--output", "-o"),
+) -> None:
+    """Get metadata about the current API key.
+
+    Shows information about the API key being used, including:
+    - Team and environment details
+    - Key type and permissions
+    - Expiration (if applicable)
+
+    By default, uses v1 endpoint (API key). Use --v2 to query management key info.
+
+    Examples:
+        # Use v1 endpoint (default)
+        hny auth get
+
+        # Use v2 endpoint (management key)
+        hny auth get --v2
+
+        # Output as JSON
+        hny auth get --output json
+    """
+    try:
+        # Based on the flag, only pass relevant credentials to client
+        if v2:
+            # Use v2: only pass management credentials
+            client = get_client(
+                profile=profile,
+                management_key=management_key,
+                management_secret=management_secret,
+            )
+            auth_info = client.auth.get(use_v2=True)
+        else:
+            # Use v1 (default): only pass API key
+            client = get_client(
+                profile=profile,
+                api_key=api_key,
+            )
+            auth_info = client.auth.get(use_v2=False)
+
+        output_result(auth_info, output)
+
+    except ValueError as e:
+        console.print(f"[red]Error:[/red] {e}", style="bold")
+        raise typer.Exit(1)
+    except Exception as e:
+        console.print(f"[red]Error:[/red] {e}", style="bold")
+        raise typer.Exit(1)