Skip to main content

Python client package for the ARP Standard (v1).

Project description

ARP Standard Python Client (arp-standard-client)

Install

python3 -m pip install arp-standard-client

Usage

from arp_standard_client.daemon import DaemonClient
from arp_standard_model import (
    DaemonCreateInstancesRequest,
    DaemonHealthRequest,
    DaemonListInstancesRequest,
    DaemonListRunsParams,
    DaemonListRunsRequest,
    InstanceCreateRequestBody,
)

client = DaemonClient(base_url="http://127.0.0.1:8082")
health = client.health(DaemonHealthRequest())
instances = client.list_instances(DaemonListInstancesRequest())
created = client.create_instances(
    DaemonCreateInstancesRequest(
        body=InstanceCreateRequestBody(runtime_profile="default", count=1)
    )
)
runs = client.list_runs(DaemonListRunsRequest(params=DaemonListRunsParams(page_size=50)))

Request objects

All facade methods require a single request object from arp_standard_model. These request objects wrap:

  • params: path/query parameters (if any)
  • body: JSON request body (if any)

Request and params models are service-prefixed (e.g., DaemonListRunsRequest, RuntimeGetRunStatusRequest) to avoid collisions. Request body models are also exported with a *RequestBody alias (e.g., InstanceCreateRequestBody).

Wire format

Models use the exact JSON field names from the spec (no aliasing). When serializing manually, use model_dump(exclude_none=True).

Authentication (API key)

client = DaemonClient(
    base_url="http://127.0.0.1:8082",
    headers={"X-API-Key": "your-api-key"},
)

Streaming (NDJSON)

Streaming endpoints currently return NDJSON as plain text. Helpers are planned but not implemented yet.

from arp_standard_client.runtime import RuntimeClient
from arp_standard_model import RuntimeStreamRunEventsParams, RuntimeStreamRunEventsRequest

runtime = RuntimeClient(base_url="http://127.0.0.1:8081")
text = runtime.get_run_events(
    RuntimeStreamRunEventsRequest(params=RuntimeStreamRunEventsParams(run_id=run_id))
)
for line in text.splitlines():
    if not line:
        continue
    # json.loads(line)

Spec reference

arp_standard_client.SPEC_REF exposes the spec tag (for example, spec/v1@v0.2.0) used to generate the package.

See also

General Documentation

Python Specific Documentation

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

arp_standard_client-0.2.0.tar.gz (24.5 kB view details)

Uploaded Source

Built Distribution

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

arp_standard_client-0.2.0-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for arp_standard_client-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c6de7d019a2a668ea1b0fa8405547d2e1fb0f097d1713ee1e4b6086c9fa252fc
MD5 608d3552aaba5fb1045172aac60ed758
BLAKE2b-256 2ffe4991e37281d23b0d854cf7c63fc0ce318540e9004e48543e553952f82bbb

See more details on using hashes here.

Provenance

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

Publisher: release.yml on AgentRuntimeProtocol/ARP_Standard

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

File details

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

File metadata

File hashes

Hashes for arp_standard_client-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58268619d6550f95ab696ec628bc35b4b4ea1536156c10f68cb3d81d77bc4cbd
MD5 1d104ff7d0c28ac214aaadb5dba46af5
BLAKE2b-256 20a5fe0d0a5a9722ed634465f3ecf01a15d70cd9bbc1c9b47392f916eac4df1b

See more details on using hashes here.

Provenance

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

Publisher: release.yml on AgentRuntimeProtocol/ARP_Standard

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