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.303

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.303
File Actions
codebuddy_agent_sdk-0.3.303-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for codebuddy_agent_sdk-0.3.303-py3-none-win_amd64.whl
codebuddy_agent_sdk-0.3.303-py3-none-musllinux_1_1_x86_64.whl Python 3 none Linux musl 1.1+ x86-64 Details for codebuddy_agent_sdk-0.3.303-py3-none-musllinux_1_1_x86_64.whl
codebuddy_agent_sdk-0.3.303-py3-none-musllinux_1_1_aarch64.whl Python 3 none Linux musl 1.1+ ARM64 Details for codebuddy_agent_sdk-0.3.303-py3-none-musllinux_1_1_aarch64.whl
codebuddy_agent_sdk-0.3.303-py3-none-manylinux_2_17_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details for codebuddy_agent_sdk-0.3.303-py3-none-manylinux_2_17_x86_64.whl
codebuddy_agent_sdk-0.3.303-py3-none-manylinux_2_17_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64 Details for codebuddy_agent_sdk-0.3.303-py3-none-manylinux_2_17_aarch64.whl
codebuddy_agent_sdk-0.3.303-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for codebuddy_agent_sdk-0.3.303-py3-none-macosx_11_0_arm64.whl
codebuddy_agent_sdk-0.3.303-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details for codebuddy_agent_sdk-0.3.303-py3-none-macosx_10_12_x86_64.whl

Total release size: 474.7 MB

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

Download URL codebuddy_agent_sdk-0.3.303-py3-none-win_amd64.whl
Size 74.7 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
d979837aeecbc431c3bdd3298e25a05486de986ebda20f468f56dc65c5389fa7
BLAKE2b-256 checksum
How to use checksums
7171612016c8dd805e8a1abe265bb96e7b39920e224c18299623bb54e93f26e9
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.303-py3-none-musllinux_1_1_x86_64.whl

Download URL codebuddy_agent_sdk-0.3.303-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
f60920155c3b3c50fd952772b050715766a94dc0630ba83371b64899379bdb0d
BLAKE2b-256 checksum
How to use checksums
b2474f346faddbd8a42446d2e3cf9824ffaffe58a0a3702706d70e7cd94fc9c8
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.303-py3-none-musllinux_1_1_aarch64.whl

Download URL codebuddy_agent_sdk-0.3.303-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
472caff06bfaa4d9f89f55c1eb8fbeea4f6ad23913beaf587054c79d0a4fed72
BLAKE2b-256 checksum
How to use checksums
d38a931e75a833328b63f36fe614f1cd469956cdc40dead870772f4a0c22a012
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.303-py3-none-manylinux_2_17_x86_64.whl

Download URL codebuddy_agent_sdk-0.3.303-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
76f18748b3913a4cc3b2340fe2cd773331c64bd06f698bc2148ee6292f46cb5d
BLAKE2b-256 checksum
How to use checksums
a987c4c15c5054de6f7602f10ebb2b184f0045fdde338ddffe525f37fcbf1049
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.303-py3-none-manylinux_2_17_aarch64.whl

Download URL codebuddy_agent_sdk-0.3.303-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
854fba1eaeb340822d70061f487eeda7b51f276e7fec01688d241d85c630fdea
BLAKE2b-256 checksum
How to use checksums
fcaa0c310ccc1079d4726165b4f5fb9454671287316f447fd332e46a511a68a9
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.303-py3-none-macosx_11_0_arm64.whl

Download URL codebuddy_agent_sdk-0.3.303-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
647be5f00e8333c6077f2a0a1b597fe8086f2262db78c0b9d68039efca801ff9
BLAKE2b-256 checksum
How to use checksums
1d014b027ed06ac2cb384ad728bb855161f2282add16e6d3b4ec4e37a25e08d4
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.303-py3-none-macosx_10_12_x86_64.whl

Download URL codebuddy_agent_sdk-0.3.303-py3-none-macosx_10_12_x86_64.whl
Size 63.6 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
1a0a59ed6d7ab988f21947d32f7ab587017b95efa7172622e6e489b5294e142a
BLAKE2b-256 checksum
How to use checksums
59a5806ce36a7e74c02ece42d4245acbc1507c2227430ba44da56f4d16dca0c6
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.303

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.303 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