Pre-release
This release is a pre-release and may not be stable for production use.
CodeBuddy Agent SDK for Python
SDK for building AI agents with CodeBuddy Code's capabilities. Programmatically interact with AI to build autonomous agents that can understand codebases, edit files, and execute workflows.
Installation
# Using uv (recommended)
uv add codebuddy-agent-sdk
# Using pip
pip install codebuddy-agent-sdk
Quick Start
import asyncio
from codebuddy_agent_sdk import query
async def main():
async for message in query(
prompt="What files are in this directory?",
permission_mode="bypassPermissions",
):
if message.type == "assistant":
for block in message.content:
if hasattr(block, "text"):
print(block.text)
asyncio.run(main())
API Reference
query(prompt, **options)
Create a query to interact with the agent.
async for message in query(
prompt="Your prompt here",
model="sonnet", # Model to use
permission_mode="bypassPermissions", # Permission mode
max_turns=10, # Maximum conversation turns
cwd="/path/to/project", # Working directory
):
# Handle message
pass
Message Types
system- Session initialization infoassistant- Agent responses (text, tool calls)result- Query completion statustask_started/task_notification- Background task lifecycle events (TaskStartedMessage/TaskNotificationMessage, both subclasses ofSystemMessage). Emitted when a tool runs a command withrun_in_background: true. Concurrent tasks are told apart bytask_id.
Background tasks
Background task completion can arrive after the first ResultMessage, so use
CodeBuddySDKClient with receive_messages() (which keeps reading) rather than
query() / receive_response() (which stop at the first result):
from codebuddy_agent_sdk import (
CodeBuddySDKClient,
CodeBuddyAgentOptions,
TaskStartedMessage,
TaskNotificationMessage,
)
async def main():
options = CodeBuddyAgentOptions(permission_mode="bypassPermissions")
async with CodeBuddySDKClient(options=options) as client:
await client.query("Run a background command and report when it finishes")
async for msg in client.receive_messages():
if isinstance(msg, TaskStartedMessage):
print("started", msg.task_id, msg.description)
elif isinstance(msg, TaskNotificationMessage):
print("done", msg.task_id, msg.status, msg.output_file)
Related Links
Feedback
- Submit issues at Issues
- Contact: codebuddy@tencent.com
1 maintainer
Metadata
1 maintainer
Release files for codebuddy-agent-sdk 0.3.287.dev202610232256
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-win_amd64.whl | Python 3 | none | Windows x86-64 | Details |
| codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-musllinux_1_1_x86_64.whl | Python 3 | none | Linux musl 1.1+ x86-64 | Details |
| codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-musllinux_1_1_aarch64.whl | Python 3 | none | Linux musl 1.1+ ARM64 | Details |
| codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-manylinux_2_17_x86_64.whl | Python 3 | none | Linux glibc 2.17+ x86-64 | Details |
| codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-manylinux_2_17_aarch64.whl | Python 3 | none | Linux glibc 2.17+ ARM64 | Details |
| codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-macosx_11_0_arm64.whl | Python 3 | none | macOS 11.0+ ARM64 | Details |
| codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-macosx_10_12_x86_64.whl | Python 3 | none | macOS 10.12+ x86-64 | Details |
Total release size: 394.6 MB
Release files / codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-win_amd64.whl
| Download URL | codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-win_amd64.whl |
|---|---|
| Size | 63.0 MB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
def6e6f09a05adecfa5d8c621ce0c425c892b5900b04191f0c748d9e15447300
|
|
BLAKE2b-256 checksum How to use checksums |
2f363c0974784c2180ce08591b6ef771c6237a7bfc6b927153571be745a2123d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-musllinux_1_1_x86_64.whl
| Download URL | codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-musllinux_1_1_x86_64.whl |
|---|---|
| Size | 56.1 MB |
| Tags | Linux musl 1.1+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
b3d8c53c1a4b876e4ee8de59ca05d15b372bbe0a41dc44df0656c7f16ad22a9c
|
|
BLAKE2b-256 checksum How to use checksums |
38b9cad7f0d1916cc396b4241c9bd6786e6f1de4aa36055c0af62370473723fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-musllinux_1_1_aarch64.whl
| Download URL | codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-musllinux_1_1_aarch64.whl |
|---|---|
| Size | 55.6 MB |
| Tags | Linux musl 1.1+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
1179a24ae768c07755a9707397543b9dc0dc78928153208478a25fae89b03b37
|
|
BLAKE2b-256 checksum How to use checksums |
a38d704cb70f7cd2ec491567502209ac23cb443a9f5dca172a754b15ab8c5d9b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-manylinux_2_17_x86_64.whl
| Download URL | codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-manylinux_2_17_x86_64.whl |
|---|---|
| Size | 59.5 MB |
| Tags | Linux glibc 2.17+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
01c782bd88a2b959d21210d2467737300c5cc6ddb7db68a5d5d1b6be0dd4e024
|
|
BLAKE2b-256 checksum How to use checksums |
186c6b2586d90213f0ba082c793af9c25fa3b6dc88368607aefda2831f44bc28
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-manylinux_2_17_aarch64.whl
| Download URL | codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-manylinux_2_17_aarch64.whl |
|---|---|
| Size | 59.2 MB |
| Tags | Linux glibc 2.17+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
3ff3061bc88b6476ae860168dc748a7b31aa5b8da0b44337f61cfcca6dee8676
|
|
BLAKE2b-256 checksum How to use checksums |
7bcee9c78cd473d1a9c58f339bae082ed8933ad46113e2e1cabfa8b388933706
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-macosx_11_0_arm64.whl
| Download URL | codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 49.4 MB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
d9bc38a085b7afb632eae6a11c7d7764e38e0b1898cc7ba641f97bbeeeb99a55
|
|
BLAKE2b-256 checksum How to use checksums |
e1178f4d057cabb34c2297c1dbc26502efaca8795d89dcb49ec44b8a49ad95f1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-macosx_10_12_x86_64.whl
| Download URL | codebuddy_agent_sdk-0.3.287.dev202610232256-py3-none-macosx_10_12_x86_64.whl |
|---|---|
| Size | 51.7 MB |
| Tags | Python 3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
176a7d431bba0c56b23e26d3edd6d85bb7c0c5fe410e055c018fd1a5c4b68213
|
|
BLAKE2b-256 checksum How to use checksums |
81b83178c841f88ad789cfd825a105f4cd7f50bff5989edbc5089e0777ff314d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for codebuddy-agent-sdk 0.3.287.dev202610232256
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
