Skip to main content

Lightweight SDK for pushing automation run logs to the Manage AI dashboard

Project description

Manage AI SDK

Lightweight Python SDK for pushing automation run logs to the Manage AI dashboard.

Install

pip install manage-ai-sdk
# or directly from the repo
pip install "manage-ai-sdk @ git+https://github.com/Shfa-AI/manage-ai.git#subdirectory=sdk"

Setup

Set two environment variables (or pass them explicitly):

export MANAGE_AI_URL=https://your-dashboard.example.com
export MANAGE_AI_KEY=ak_your_api_key_here

Get these from the Connection section on any automation's detail page in the dashboard.

Usage

Decorator (simplest)

from manage_ai_sdk import automation

@automation("b1000000-0000-0000-0000-000000000001")
def daily_invoice_email():
    invoices = fetch_invoices()
    send_emails(invoices)
    return {"invoices_sent": len(invoices)}

if __name__ == "__main__":
    daily_invoice_email()

The decorator automatically:

  • Reports the run as started when the function begins
  • Reports success with the return value as output when it finishes
  • Reports failure with the traceback if an exception occurs
  • Tracks duration

Context manager (for embedding in existing code)

from manage_ai_sdk import track_run

with track_run("b1000000-0000-0000-0000-000000000001") as run:
    result = do_stuff()
    run.output = {"data": result}

Explicit client (for advanced usage)

from manage_ai_sdk import ManageAI

client = ManageAI(url="https://...", api_key="ak_...")
run_id = client.start_run("b1000000-...", trigger={"type": "cron"})

try:
    result = do_stuff()
    client.complete_run("b1000000-...", run_id, output={"data": result}, duration_ms=1234)
except Exception as e:
    client.fail_run("b1000000-...", run_id, error=str(e))
    raise

Configuration priority

  1. Explicit argumentsautomation("id", url="...", api_key="...")
  2. Environment variablesMANAGE_AI_URL, MANAGE_AI_KEY

Failure behavior

If the dashboard is unreachable, the SDK logs a warning but does not crash your automation. Your code always runs regardless of whether the dashboard is available.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

manage_ai_sdk-0.2.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

manage_ai_sdk-0.2.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file manage_ai_sdk-0.2.0.tar.gz.

File metadata

  • Download URL: manage_ai_sdk-0.2.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for manage_ai_sdk-0.2.0.tar.gz
Algorithm Hash digest
SHA256 97d342e5db29bb7c2d9b702167b0fe09e2dde28df1f6cd3bd1fe617c810436b4
MD5 1ccf7935977cc61453fab91ae3f01eee
BLAKE2b-256 3a598918f36dabfd8f5e516681c7e8671c63ba4560024f655c4507919d587734

See more details on using hashes here.

Provenance

The following attestation bundles were made for manage_ai_sdk-0.2.0.tar.gz:

Publisher: publish-sdk.yml on Shfa-AI/manage-ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file manage_ai_sdk-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: manage_ai_sdk-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for manage_ai_sdk-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a2280af3ef416bc4d09d2f1df67023ef6568607a1a90d5a498ab7fa2c138b34e
MD5 870f43437ba3bdec7395bdb3dfdc5a63
BLAKE2b-256 a6ddd85f229672141f22a4449b3e201e2a91d450111d4ba9ee45d71398d84e5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for manage_ai_sdk-0.2.0-py3-none-any.whl:

Publisher: publish-sdk.yml on Shfa-AI/manage-ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page