devhelm 0.6.0__tar.gz → 0.6.2__tar.gz

{devhelm-0.6.0 → devhelm-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devhelm
-Version: 0.6.0
+Version: 0.6.2
 Summary: DevHelm SDK for Python — typed client for monitors, incidents, alerting, and more
 Project-URL: Homepage, https://github.com/devhelmhq/sdk-python
 Project-URL: Repository, https://github.com/devhelmhq/sdk-python.git
@@ -37,11 +37,7 @@ pip install devhelm
 ```python
 from devhelm import Devhelm
 
-client = Devhelm(
-    token="your-api-token",
-    org_id="your-org-id",
-    workspace_id="your-workspace-id",
-)
+client = Devhelm(token="your-api-token")
 
 # List all monitors
 monitors = client.monitors.list()
@@ -55,6 +51,11 @@ monitor = client.monitors.create({
     "config": {"url": "https://api.example.com/health", "method": "GET"},
     "frequencySeconds": 60,
     "regions": ["us-east"],
+    # `managedBy` records who reconciles drift on this resource. Use
+    # "DASHBOARD" (the default for one-off SDK scripts), "CLI" if the
+    # monitor lives in a `devhelm.yml` you re-deploy, or "TERRAFORM"
+    # if it lives in `.tf` you re-apply.
+    "managedBy": "DASHBOARD",
 })
 
 # Get a single monitor
@@ -74,20 +75,20 @@ client.monitors.delete(monitor.id)
 from devhelm import Devhelm
 
 client = Devhelm(
-    token="your-api-token",           # required (or DEVHELM_API_TOKEN env var)
-    org_id="1",                        # required (or DEVHELM_ORG_ID env var)
-    workspace_id="1",                  # required (or DEVHELM_WORKSPACE_ID env var)
+    token="your-api-token",            # required (or DEVHELM_API_TOKEN env var)
+    org_id="1",                        # optional — see notes below
+    workspace_id="1",                  # optional — see notes below
     base_url="https://api.devhelm.io", # optional, defaults to production
 )
 ```
 
 Environment variables are used as fallbacks when constructor arguments are not provided:
 
-| Parameter      | Env Variable            |
-| -------------- | ----------------------- |
-| `token`        | `DEVHELM_API_TOKEN`     |
-| `org_id`       | `DEVHELM_ORG_ID`        |
-| `workspace_id` | `DEVHELM_WORKSPACE_ID`  |
+| Parameter      | Required | Env Variable           | Notes                                                                                                    |
+| -------------- | -------- | ---------------------- | -------------------------------------------------------------------------------------------------------- |
+| `token`        | Yes      | `DEVHELM_API_TOKEN`    | Personal or workspace API token.                                                                         |
+| `org_id`       | No       | `DEVHELM_ORG_ID`       | Auto-resolved if your token is scoped to one org. Required only when the token has access to multiple.   |
+| `workspace_id` | No       | `DEVHELM_WORKSPACE_ID` | Auto-resolved if your token is scoped to one workspace. Required only when the token spans multiple.     |
 
 ## Resources
 
@@ -154,7 +155,7 @@ Every `DevhelmApiError` carries:
 ```python
 from devhelm import Devhelm, DevhelmAuthError, DevhelmError
 
-client = Devhelm(token="bad-token", org_id="1", workspace_id="1")
+client = Devhelm(token="bad-token")
 
 try:
     client.monitors.list()

{devhelm-0.6.0 → devhelm-0.6.2}/README.md

@@ -13,11 +13,7 @@ pip install devhelm
 ```python
 from devhelm import Devhelm
 
-client = Devhelm(
-    token="your-api-token",
-    org_id="your-org-id",
-    workspace_id="your-workspace-id",
-)
+client = Devhelm(token="your-api-token")
 
 # List all monitors
 monitors = client.monitors.list()
@@ -31,6 +27,11 @@ monitor = client.monitors.create({
     "config": {"url": "https://api.example.com/health", "method": "GET"},
     "frequencySeconds": 60,
     "regions": ["us-east"],
+    # `managedBy` records who reconciles drift on this resource. Use
+    # "DASHBOARD" (the default for one-off SDK scripts), "CLI" if the
+    # monitor lives in a `devhelm.yml` you re-deploy, or "TERRAFORM"
+    # if it lives in `.tf` you re-apply.
+    "managedBy": "DASHBOARD",
 })
 
 # Get a single monitor
@@ -50,20 +51,20 @@ client.monitors.delete(monitor.id)
 from devhelm import Devhelm
 
 client = Devhelm(
-    token="your-api-token",           # required (or DEVHELM_API_TOKEN env var)
-    org_id="1",                        # required (or DEVHELM_ORG_ID env var)
-    workspace_id="1",                  # required (or DEVHELM_WORKSPACE_ID env var)
+    token="your-api-token",            # required (or DEVHELM_API_TOKEN env var)
+    org_id="1",                        # optional — see notes below
+    workspace_id="1",                  # optional — see notes below
     base_url="https://api.devhelm.io", # optional, defaults to production
 )
 ```
 
 Environment variables are used as fallbacks when constructor arguments are not provided:
 
-| Parameter      | Env Variable            |
-| -------------- | ----------------------- |
-| `token`        | `DEVHELM_API_TOKEN`     |
-| `org_id`       | `DEVHELM_ORG_ID`        |
-| `workspace_id` | `DEVHELM_WORKSPACE_ID`  |
+| Parameter      | Required | Env Variable           | Notes                                                                                                    |
+| -------------- | -------- | ---------------------- | -------------------------------------------------------------------------------------------------------- |
+| `token`        | Yes      | `DEVHELM_API_TOKEN`    | Personal or workspace API token.                                                                         |
+| `org_id`       | No       | `DEVHELM_ORG_ID`       | Auto-resolved if your token is scoped to one org. Required only when the token has access to multiple.   |
+| `workspace_id` | No       | `DEVHELM_WORKSPACE_ID` | Auto-resolved if your token is scoped to one workspace. Required only when the token spans multiple.     |
 
 ## Resources
 
@@ -130,7 +131,7 @@ Every `DevhelmApiError` carries:
 ```python
 from devhelm import Devhelm, DevhelmAuthError, DevhelmError
 
-client = Devhelm(token="bad-token", org_id="1", workspace_id="1")
+client = Devhelm(token="bad-token")
 
 try:
     client.monitors.list()

{devhelm-0.6.0 → devhelm-0.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "devhelm"
-version = "0.6.0"
+version = "0.6.2"
 description = "DevHelm SDK for Python — typed client for monitors, incidents, alerting, and more"
 authors = [{ name = "DevHelm", email = "hello@devhelm.io" }]
 license = "MIT"

{devhelm-0.6.0 → devhelm-0.6.2}/tests/run_sdk.py

@@ -393,6 +393,20 @@ def run(client: Devhelm, resource: str, action: str, rest: list[str]) -> Any:  #
         client.status_pages.subscribers.remove(rest[0], rest[1])
         return None
 
+    # -- Forensics --
+    if op == "forensics.incident-timeline":
+        return client.forensics.incident_timeline(rest[0])
+    if op == "forensics.check-trace":
+        return client.forensics.check_trace(rest[0])
+    if op == "forensics.policy-snapshot":
+        return client.forensics.policy_snapshot(rest[0])
+    if op == "forensics.monitor-rule-evaluations":
+        opts = json.loads(rest[1]) if len(rest) > 1 and rest[1] else {}
+        return client.forensics.monitor_rule_evaluations(rest[0], **opts)
+    if op == "forensics.monitor-transitions":
+        opts = json.loads(rest[1]) if len(rest) > 1 and rest[1] else {}
+        return client.forensics.monitor_transitions(rest[0], **opts)
+
     # -- Status Page Domains --
     if op == "status-pages.domains.list":
         return client.status_pages.domains.list(rest[0])

{devhelm-0.6.0 → devhelm-0.6.2}/tests/test_client.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 import pytest
 
 from devhelm import Devhelm
+from devhelm._http import DevhelmConfig
 from devhelm.resources.alert_channels import AlertChannels
 from devhelm.resources.api_keys import ApiKeys
 from devhelm.resources.dependencies import Dependencies
@@ -131,3 +132,31 @@ class TestStatusPagesResource:
         assert callable(d.add)
         assert callable(d.verify)
         assert callable(d.remove)
+
+
+class TestClientOptionalTenantArgs:
+    """`org_id` / `workspace_id` are optional — single-tenant tokens
+    auto-resolve them server-side, so the README quickstart and the
+    constructor must work with just a token (the most common case).
+    """
+
+    def test_constructible_without_org_or_workspace(
+        self, monkeypatch: pytest.MonkeyPatch
+    ) -> None:
+        # Strip any env fallback so we prove the constructor itself accepts
+        # missing tenant args, not that the test environment leaks them in.
+        monkeypatch.delenv("DEVHELM_ORG_ID", raising=False)
+        monkeypatch.delenv("DEVHELM_WORKSPACE_ID", raising=False)
+
+        client = Devhelm(token="test-token", base_url="http://localhost:8080")
+
+        assert client.monitors is not None
+        assert client.incidents is not None
+
+    def test_config_defaults_tenant_ids_to_none(self) -> None:
+        # Documents the API contract: leaving them unset on the config
+        # dataclass yields ``None``, which ``build_client`` then resolves
+        # via env var or the server-side default.
+        config = DevhelmConfig(token="test-token")
+        assert config.org_id is None
+        assert config.workspace_id is None

{devhelm-0.6.0 → devhelm-0.6.2}/uv.lock

@@ -315,7 +315,7 @@ wheels = [
 
 [[package]]
 name = "devhelm"
-version = "0.6.0"
+version = "0.6.2"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },