Skip to main content

CAP (Cortex Agent Protocol) Python SDK

Project description

CAP Python SDK

Asyncio-first SDK with NATS helpers for CAP workers and clients.

Quick Start

  1. Generate protobuf stubs into this SDK (one-time per proto change):

    python -m grpc_tools.protoc \
      -I../../proto \
      --python_out=./cap/pb \
      --grpc_python_out=./cap/pb \
      ../../proto/cortex/agent/v1/*.proto
    

    (Or run ./tools/make_protos.sh from repo root and copy generated/python into sdk/python/cap/pb.)

  2. Install:

    pip install -e .
    
  3. Run a worker:

    import asyncio
    from cap import worker
    from cap.pb.cortex.agent.v1 import job_pb2
    
    async def handle(req: job_pb2.JobRequest):
        return job_pb2.JobResult(
            job_id=req.job_id,
            status=job_pb2.JOB_STATUS_SUCCEEDED,
            result_ptr=f"redis://res/{req.job_id}",
            worker_id="worker-echo-1",
        )
    
    asyncio.run(worker.run_worker("nats://127.0.0.1:4222", "job.echo", handle))
    

Files

  • cap/bus.py — NATS connector.
  • cap/worker.py — worker skeleton with handler hook.
  • cap/client.py — publish JobRequest to sys.job.submit.
  • cap/pb/ — protobuf stubs (generated).

Defaults

  • Subjects: sys.job.submit, sys.job.result, sys.heartbeat.
  • Protocol version: 1.

Swap out cap.bus if you need a different transport.

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

cap_sdk_python-0.1.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

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

cap_sdk_python-0.1.0-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file cap_sdk_python-0.1.0.tar.gz.

File metadata

  • Download URL: cap_sdk_python-0.1.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for cap_sdk_python-0.1.0.tar.gz
Algorithm Hash digest
SHA256 eb88ae5d0750d6d9dd5685100ad885c014995da070eabd84bc508caf932fad27
MD5 1bf09a352b346304c0ae4a56af31a317
BLAKE2b-256 bbb26ecd7daf3fe2bebf25b990f453e07eb5f2bfde5d88e65dedafcf9966d838

See more details on using hashes here.

File details

Details for the file cap_sdk_python-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: cap_sdk_python-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for cap_sdk_python-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec9df63922a2c4c378dba14d730b551f21a4dcb4c878219acb342253cd74ee48
MD5 ae6acb0131739484fdeeb7e9ab24d62c
BLAKE2b-256 538aef27659b5aac1685b8334122236e1d92893d591615d7eb540ae11bb7b15a

See more details on using hashes here.

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