Skip to main content

CAP (coretex 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/coretex/agent/v1/*.proto
    

    (Or run ./tools/make_protos.sh from repo root with CAP_RUN_PY=1 and copy /python into sdk/python/cap/pb if you want vendored stubs.)

  2. Install:

    pip install -e .
    
  3. Run a worker:

    import asyncio
    from cap import worker
    from cap.pb.coretex.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-2.0.4.tar.gz (9.7 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-2.0.4-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cap_sdk_python-2.0.4.tar.gz
  • Upload date:
  • Size: 9.7 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-2.0.4.tar.gz
Algorithm Hash digest
SHA256 b33c7a315b3f409fc4f3eef036251b84ad6d2ef9ac1454f638b8274d64f16176
MD5 80ce0c9b16370925337d3f06edf4ac46
BLAKE2b-256 7fbcafbef03fc2665e17c532fdb5db9a9925aab07e501645653cb2cd12c79bc5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cap_sdk_python-2.0.4-py3-none-any.whl
  • Upload date:
  • Size: 16.9 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-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 249bfa4b5a689a8afbaa20fa46ec558f152a5b44d081ada47e99e7856be35733
MD5 ba71eb5331ff5bd12384ff8d084ae072
BLAKE2b-256 0f04e79b30ab4f5c1967376714ab1d285d403539976c0a622c019340c9796e60

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