Skip to main content

Client SDK for the CCCC daemon (IPC v1)

Project description

CCCC Python SDK

This package is the Python client SDK for CCCC daemon (Daemon IPC v1).

Relationship to CCCC core

  • CCCC core repository: https://github.com/ChesterRa/cccc
  • cccc core owns daemon/web/CLI and runtime state under CCCC_HOME.
  • cccc-sdk provides client APIs only and must connect to a running daemon.

It requires a running CCCC daemon. The SDK does not ship a daemon.

Versioning

This SDK tracks CCCC major/minor (0.4.x), while patch/RC cadence is SDK-owned:

  • Stable example: cccc-sdk==0.4.0 with cccc==0.4.x
  • RC preview example: cccc-sdk==0.4.1rc1 with cccc==0.4.x

Daemon endpoint discovery

The SDK connects to the daemon endpoint described by:

  • ${CCCC_HOME}/daemon/ccccd.addr.json (preferred, cross-platform), or
  • ${CCCC_HOME}/daemon/ccccd.sock (POSIX AF_UNIX fallback)

Install

Stable (PyPI)

pip install -U cccc-sdk

RC preview (optional, TestPyPI first)

pip install -U --pre --index-url https://pypi.org/simple \
  --extra-index-url https://test.pypi.org/simple \
  cccc-sdk

From source (development)

pip install -e .

Usage

python - <<'PY'
from cccc_sdk import CCCCClient

c = CCCCClient()
c.assert_compatible(require_ipc_v=1, require_capabilities={"events_stream": True})

groups = c.groups()
print(groups)
PY

Examples (repo)

This repository includes runnable examples under python/examples/:

python examples/compat_check.py

Stream events for a group:

python examples/stream.py --group g_xxx

Send a message:

python examples/send.py --group g_xxx --text "hello"

Auto-ACK attention messages (as a recipient):

python examples/auto_ack_attention.py --group g_xxx --actor user

Add a note to shared context:

python examples/context_add_note.py --group g_xxx --content "remember to do X"

Cross-group send:

python examples/send_cross_group.py --src g_src --dst g_dst --text "hello from src"

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

cccc_sdk-0.4.0.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

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

cccc_sdk-0.4.0-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file cccc_sdk-0.4.0.tar.gz.

File metadata

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

File hashes

Hashes for cccc_sdk-0.4.0.tar.gz
Algorithm Hash digest
SHA256 52c7569964f50e157488a0d57a9ddedbb1b143276a2c36a9b969b104eb0901a9
MD5 2779a1f8bb6df974e9c9f2c2943ad905
BLAKE2b-256 b7d8321f2a24e2fe7ff735787e4aab724024e3e999b51be7271ec9b5c4b32308

See more details on using hashes here.

File details

Details for the file cccc_sdk-0.4.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for cccc_sdk-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b991c7a87ebf6e0a8ab7097fb7daaeebb2048cac4a247b32819ca0af2e5113ca
MD5 5060a0859978041f47af48611d7196da
BLAKE2b-256 e68331ccc432ee5ab1f8b52d808d2610aa5f06a130525434e9643a8fbbbf1d97

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