Skip to main content

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 info
  • assistant - Agent responses (text, tool calls)
  • result - Query completion status
  • task_started / task_notification - Background task lifecycle events (TaskStartedMessage / TaskNotificationMessage, both subclasses of SystemMessage). Emitted when a tool runs a command with run_in_background: true. Concurrent tasks are told apart by task_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)

Feedback

Metadata

Release files for codebuddy-agent-sdk 0.3.302

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for codebuddy-agent-sdk 0.3.302
File Actions
codebuddy_agent_sdk-0.3.302-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for codebuddy_agent_sdk-0.3.302-py3-none-win_amd64.whl
codebuddy_agent_sdk-0.3.302-py3-none-musllinux_1_1_x86_64.whl Python 3 none Linux musl 1.1+ x86-64 Details for codebuddy_agent_sdk-0.3.302-py3-none-musllinux_1_1_x86_64.whl
codebuddy_agent_sdk-0.3.302-py3-none-musllinux_1_1_aarch64.whl Python 3 none Linux musl 1.1+ ARM64 Details for codebuddy_agent_sdk-0.3.302-py3-none-musllinux_1_1_aarch64.whl
codebuddy_agent_sdk-0.3.302-py3-none-manylinux_2_17_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details for codebuddy_agent_sdk-0.3.302-py3-none-manylinux_2_17_x86_64.whl
codebuddy_agent_sdk-0.3.302-py3-none-manylinux_2_17_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64 Details for codebuddy_agent_sdk-0.3.302-py3-none-manylinux_2_17_aarch64.whl
codebuddy_agent_sdk-0.3.302-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for codebuddy_agent_sdk-0.3.302-py3-none-macosx_11_0_arm64.whl
codebuddy_agent_sdk-0.3.302-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details for codebuddy_agent_sdk-0.3.302-py3-none-macosx_10_12_x86_64.whl

Total release size: 474.4 MB

Release files / codebuddy_agent_sdk-0.3.302-py3-none-win_amd64.whl

Download URL codebuddy_agent_sdk-0.3.302-py3-none-win_amd64.whl
Size 74.7 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
6de291f7b45036ba470f5219459c67ee151653babb267ea8fe6b07671f023392
BLAKE2b-256 checksum
How to use checksums
d843a0737a9dad9a67b340bdf8be39e5fccac46f1e889db36b2a9d2f88199090
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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.302-py3-none-musllinux_1_1_x86_64.whl

Download URL codebuddy_agent_sdk-0.3.302-py3-none-musllinux_1_1_x86_64.whl
Size 67.3 MB
Tags Linux musl 1.1+ x86-64 Python 3
SHA-256 checksum
How to use checksums
eba649562753b95e5bb5bd45f0a0dc305d5eaea4cf03069b56d950acdecc54b5
BLAKE2b-256 checksum
How to use checksums
1917437f1bd6cd99c7fa127e562a656daf977ccea2c12ef0b8089c1c715260c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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.302-py3-none-musllinux_1_1_aarch64.whl

Download URL codebuddy_agent_sdk-0.3.302-py3-none-musllinux_1_1_aarch64.whl
Size 66.8 MB
Tags Linux musl 1.1+ ARM64 Python 3
SHA-256 checksum
How to use checksums
c10a22b302a4ece858d3fe38476e60fdf2d9a4adaf9770a74817f972bf8b87f2
BLAKE2b-256 checksum
How to use checksums
106f6f6741b9ed0cb9972413d621b4a7054d0157f466aa9302bea78740224535
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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.302-py3-none-manylinux_2_17_x86_64.whl

Download URL codebuddy_agent_sdk-0.3.302-py3-none-manylinux_2_17_x86_64.whl
Size 70.8 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
9c4e027622b0d5102ccc3225b54d36d15f306f2dd07d3483abe2b46948fa11ff
BLAKE2b-256 checksum
How to use checksums
bd76ec829288a98be0abdd435d4240bd733a404b1e30554e1fc1876b8692f6bc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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.302-py3-none-manylinux_2_17_aarch64.whl

Download URL codebuddy_agent_sdk-0.3.302-py3-none-manylinux_2_17_aarch64.whl
Size 70.6 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
c484d9dc77d8ee3814bb7c3c4362291880b3935bf29ced2a548054bea8e1819c
BLAKE2b-256 checksum
How to use checksums
25309056ff116eed3b0511bd4c6e2c3d9bac0c591b003a59b1aa1d0c3665d3b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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.302-py3-none-macosx_11_0_arm64.whl

Download URL codebuddy_agent_sdk-0.3.302-py3-none-macosx_11_0_arm64.whl
Size 60.9 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
0edb130a531f7471e0df52bf5ac2d2b2fd4cf927331ac6beca83e14a6f60fd94
BLAKE2b-256 checksum
How to use checksums
eee26b4596fd461214f76a21ea29a73d2249765e77769f4b3101f7e665107f20
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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.302-py3-none-macosx_10_12_x86_64.whl

Download URL codebuddy_agent_sdk-0.3.302-py3-none-macosx_10_12_x86_64.whl
Size 63.5 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
642f6af0a5a44397ba4106afad2aa798f5c883a52ba8056341958971c6027afb
BLAKE2b-256 checksum
How to use checksums
d2b37c73ea2d185ec01a85b516995e146ca1aa3f9bdaecc6db72e2ef632c1e9b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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.302

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.

Release history Release notifications | RSS feed

This release

0.3.302 This release

7 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page