Skip to main content

Python SDK, CLI, and MCP server for the C3PO research platform

Project description

c3po-sdk

Python SDK, CLI, and MCP server for the C3PO research platform.

Installation

uv tool install c3po-sdk

Modules

Client (c3po_sdk.client)

Python SDK for the C3PO API.

from c3po_sdk.client.client import C3poClient

async with C3poClient() as client:
    cursor: str | None = None
    while True:
        page = await client.datasets.list(last_evaluated_key=cursor, limit=50)
        for dataset in page.items:
            ...
        if not page.has_more:
            break
        cursor = page.last_evaluated_key

CLI (c3po_sdk.cli)

c3po --help

CLI commands

Global options (where supported): --output / -o (rich | plain | json), --profile, --no-pager (skip paging for JSON on a TTY), --output-file / -O PATH (write JSON to a file; requires -o json), --version / -V. Set C3PO_NO_PAGER=1 to disable paging without a flag. Use c3po <group> <command> --help for flags and arguments.

auth

  • c3po auth status

configure

  • c3po configure auth

datasets

  • c3po datasets list
  • c3po datasets get
  • c3po datasets update
  • c3po datasets tree
  • c3po datasets assets

kb (analytics knowledge base — POST /v1/kb/query: NL question → generated SQL and executed result rows in one response)

  • c3po kb query [QUESTION] — pass the question as an argument or pipe text on stdin; use --output json for the raw sql / columns / rows object.
  • Timeouts: In CDK this route uses the streaming API Lambda with a 15-minute Lambda and API Gateway integration timeout (c3po_backend/services/api/_constructs/api.py). The SDK applies the same ceiling for the HTTP read timeout so long NL2SQL + Redshift runs are not cut off early by the default httpx limits used elsewhere.

nodes (all subcommands take a NODE_ID unless noted)

  • c3po nodes get NODE_ID — node details; optional --tree for dataset subtree
  • c3po nodes update NODE_ID--name, --description
  • c3po nodes reset NODE_ID — clear pipeline outputs (--force / -f)
  • c3po nodes cluster NODE_ID — cell clustering (--obs-variable, repeatable --obs-values, --run-pipeline)
  • c3po nodes assets NODE_ID — presigned asset URLs; --download to fetch files

nodes pipeline

  • c3po nodes pipeline run NODE_ID — start execution (see --help for Leiden / IDS params); --watch / --no-watch
  • c3po nodes pipeline list NODE_ID — paginated history (--all / -a, --limit)
  • c3po nodes pipeline status NODE_ID EXECUTION_ID — Step Functions payload; --watch to poll until terminal

nodes programs (gene programs for a node)

  • c3po nodes programs list NODE_ID — paginated (--all / -a, --limit)
  • c3po nodes programs get NODE_ID PROGRAM_ID — full program record

nodes clusters (cell clusters for a node)

  • c3po nodes clusters list NODE_ID — paginated (--all / -a, --limit)
  • c3po nodes clusters get NODE_ID CLUSTER_ID — full cluster record

tenants

  • c3po tenants me
  • c3po tenants users list
  • c3po tenants credentials generate
  • c3po tenants credentials regenerate

users

  • c3po users me
  • c3po users update
  • c3po users tenants list
  • c3po users tokens list
  • c3po users tokens create
  • c3po users tokens revoke

MCP Server (c3po_sdk.mcp)

See docs/MCP.md for detailed configuration instructions.

c3po.mcp

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

c3po_sdk-0.5.0a2.tar.gz (38.8 kB view details)

Uploaded Source

Built Distribution

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

c3po_sdk-0.5.0a2-py3-none-any.whl (66.1 kB view details)

Uploaded Python 3

File details

Details for the file c3po_sdk-0.5.0a2.tar.gz.

File metadata

  • Download URL: c3po_sdk-0.5.0a2.tar.gz
  • Upload date:
  • Size: 38.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for c3po_sdk-0.5.0a2.tar.gz
Algorithm Hash digest
SHA256 84eddfb6b2fd09c2606aae7d2ab647719ca8fb46455afbfa7f5ab1b5b2fb3a04
MD5 51c4d70efc0ee694f51517fbe14800ea
BLAKE2b-256 7f8b2e36cb7689b2a1376caa081b5a6a3f38530e4195b21e5c861b4bb50a56e0

See more details on using hashes here.

File details

Details for the file c3po_sdk-0.5.0a2-py3-none-any.whl.

File metadata

  • Download URL: c3po_sdk-0.5.0a2-py3-none-any.whl
  • Upload date:
  • Size: 66.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for c3po_sdk-0.5.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 57cbd7147b2293774be9fc60e24463db3f6b15bcc4036e0152da9a97ab02f802
MD5 44488e0fa8d1a1ab0de570880f8c6fcd
BLAKE2b-256 c56305c029e6a8a777eb9a51be7724c12b53b1841c34628bdb113c2f4aab1eb7

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