Skip to main content

FastAPI server scaffolding for the ARP Standard (v1).

Project description

ARP Standard Python Server (arp-standard-server)

FastAPI server scaffolding for implementing ARP components with spec-aligned request/response types.

Install

python3 -m pip install arp-standard-server

Usage

from arp_standard_server.run_gateway import BaseRunGatewayServer
from arp_standard_server import AuthSettings
from arp_standard_model import (
    Health,
    Run,
    RunGatewayCancelRunRequest,
    RunGatewayGetRunRequest,
    RunGatewayHealthRequest,
    RunGatewayStartRunRequest,
    RunGatewayStreamRunEventsRequest,
    RunGatewayVersionRequest,
    VersionInfo,
)

class MyRunGateway(BaseRunGatewayServer):
    async def cancel_run(self, request: RunGatewayCancelRunRequest) -> Run:
        return ...

    async def get_run(self, request: RunGatewayGetRunRequest) -> Run:
        return ...

    async def health(self, request: RunGatewayHealthRequest) -> Health:
        return ...

    async def start_run(self, request: RunGatewayStartRunRequest) -> Run:
        body = request.body
        # business logic here
        return ...

    async def stream_run_events(self, request: RunGatewayStreamRunEventsRequest) -> str:
        return ""

    async def version(self, request: RunGatewayVersionRequest) -> VersionInfo:
        return ...

app = MyRunGateway().create_app(auth_settings=AuthSettings(mode="disabled"))

Service base classes

  • BaseRunGatewayServer
  • BaseRunCoordinatorServer
  • BaseAtomicExecutorServer
  • BaseCompositeExecutorServer
  • BaseNodeRegistryServer
  • BaseSelectionServer
  • BasePdpServer

Request objects

All server methods accept a single request object from arp_standard_model:

  • *Params for path/query parameters
  • *RequestBody for JSON bodies
  • *Request wrappers with params and/or body

Abstract method enforcement

Base server classes use ABC + @abstractmethod. Instantiating a class that does not implement all required endpoints raises a TypeError before the app is created.

Authentication (JWT Bearer)

app = MyRunGateway().create_app(
    auth_settings=AuthSettings(
        mode="required",
        issuer="https://issuer.example.com/realms/arp",
        audience="arp-run-gateway",
    )
)

See also: docs/security-profiles.md for the standard auth configuration profiles (Dev-Insecure, Dev-Secure-Keycloak, Enterprise).

Streaming (NDJSON)

NDJSON endpoints currently use plain text payloads. Streaming helpers are planned but not implemented yet.

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_server-0.3.1.tar.gz (12.0 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_server-0.3.1-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

Details for the file arp_standard_server-0.3.1.tar.gz.

File metadata

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

File hashes

Hashes for arp_standard_server-0.3.1.tar.gz
Algorithm Hash digest
SHA256 1863c618610579ad8c91967b9e9c4850e75928053d03148d20e84b9fc0860e8a
MD5 45e8fa254e51fec0379f515a59e46ae9
BLAKE2b-256 00f9ca548edbf4f1758c79b3b4b8378c1dc89909725f6b30eaa8ca85078685ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for arp_standard_server-0.3.1.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_server-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for arp_standard_server-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2cb79a645015b444172cdd16f6aa2c072232e5c9b308ae8bc23b5c74206b6e14
MD5 6f83f27ecc803e88ae46e45a6838ad0d
BLAKE2b-256 c4c4e611042f6a58c56168b1f23283155460b3b5aab7d3645d5d55e521f88d18

See more details on using hashes here.

Provenance

The following attestation bundles were made for arp_standard_server-0.3.1-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