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-1.0.6.tar.gz (7.6 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-1.0.6-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cap_sdk_python-1.0.6.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cap_sdk_python-1.0.6.tar.gz
Algorithm Hash digest
SHA256 f73f19ec34b92f02ec29f9afee4f94deb5783f2e12606dc3e197438e2196a74a
MD5 067da555b118dcc78765125e1aee1f01
BLAKE2b-256 809e64c33de579322a9b599d252eba38f31f46c4271214ff592fdd1a2a07e85d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cap_sdk_python-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cap_sdk_python-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 94e96691da86a1866ac2b54bcd7742d94a0faaee92989fb6b42a134f22389f0d
MD5 13c7ef6b2856e466f0367bfae066965b
BLAKE2b-256 40b1d3248a2bcdabe7b44dbd8d31d9c27418e45d4e0ceb3239d5272b159d425e

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