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)

Related Links

Feedback

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.3.240)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ninoyi from gravatar.com ninoyi

Credits

PyPI data
Data sourced directly from PyPI's database.

Author: ninoyi

Requires

Python >=3.10

Provides Extra

dev

Tags

agent ai codebuddy sdk

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

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

codebuddy_agent_sdk-0.3.239-py3-none-win_amd64.whl (52.3 MB view details)

Uploaded Python 3Windows x86-64

codebuddy_agent_sdk-0.3.239-py3-none-musllinux_1_1_x86_64.whl (47.6 MB view details)

Uploaded Python 3musllinux: musl 1.1+ x86-64

codebuddy_agent_sdk-0.3.239-py3-none-musllinux_1_1_aarch64.whl (47.4 MB view details)

Uploaded Python 3musllinux: musl 1.1+ ARM64

codebuddy_agent_sdk-0.3.239-py3-none-manylinux_2_17_x86_64.whl (49.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

codebuddy_agent_sdk-0.3.239-py3-none-manylinux_2_17_aarch64.whl (48.8 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

codebuddy_agent_sdk-0.3.239-py3-none-macosx_11_0_arm64.whl (38.0 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

codebuddy_agent_sdk-0.3.239-py3-none-macosx_10_12_x86_64.whl (40.6 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file codebuddy_agent_sdk-0.3.239-py3-none-win_amd64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.239-py3-none-win_amd64.whl
  • Upload date:
  • Size: 52.3 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.239-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 b0cfd613f2d2343447e3f3732d772b43c631e3f2b2101d234ceaae5b44b93fd3
MD5 f9ae1025bd7f20c1ecf263d085231ab4
BLAKE2b-256 f93e7c10180113a4a4b696c3c1e4620e32f42c25c19a78953dd708a43fa9eb8f

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.239-py3-none-musllinux_1_1_x86_64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.239-py3-none-musllinux_1_1_x86_64.whl
  • Upload date:
  • Size: 47.6 MB
  • Tags: Python 3, musllinux: musl 1.1+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.239-py3-none-musllinux_1_1_x86_64.whl
Algorithm Hash digest
SHA256 b48e93531af9e878f7d278461156326f3b178ec0f3bbbe612f3861fdc0ed606c
MD5 d84cf9324759b02339babe5a6812f9b9
BLAKE2b-256 748d2c2ae4925b8de48e3f86d9d3bfba3cd17ab55ca685dc0501f0cbfb7de002

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.239-py3-none-musllinux_1_1_aarch64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.239-py3-none-musllinux_1_1_aarch64.whl
  • Upload date:
  • Size: 47.4 MB
  • Tags: Python 3, musllinux: musl 1.1+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.239-py3-none-musllinux_1_1_aarch64.whl
Algorithm Hash digest
SHA256 47fe8c97a8ab97479c9304799db735748163ae7839753b0c9c58262c7f4c5224
MD5 551b166600501e27fa3811f3b68d1b52
BLAKE2b-256 741b763256719fd3fc64c1d2c2b5dd4489403463acf6c9e128363f7e993152d8

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.239-py3-none-manylinux_2_17_x86_64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.239-py3-none-manylinux_2_17_x86_64.whl
  • Upload date:
  • Size: 49.2 MB
  • Tags: Python 3, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.239-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 b3ef711daf7ab8c5570ad37f3dda07363383b873ee09a963e8b1249098b5eba3
MD5 981b978cbd84f3351a30fa88c0d6f6f6
BLAKE2b-256 13d4884ab9ec9326490ba837f57bb381337bd4ee88eb499372966b2937d70ea7

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.239-py3-none-manylinux_2_17_aarch64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.239-py3-none-manylinux_2_17_aarch64.whl
  • Upload date:
  • Size: 48.8 MB
  • Tags: Python 3, manylinux: glibc 2.17+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.239-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 ab401dd9ba2db06bca097c3f951261ae1c1ae49fc286ec2846ae23512abf20fd
MD5 fc6fc9bdef3f2360d6b27acb313f5872
BLAKE2b-256 d105adc2df018fd8f4f5b91323adc05e40e753b4bf875538712b3e7942fa8f2e

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.239-py3-none-macosx_11_0_arm64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.239-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 38.0 MB
  • Tags: Python 3, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.239-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 98f39613bfe9e01cf5e73378a56ca11b96005004feaec243d619f4f5049a6aff
MD5 3b306051d506f26db96228831721bfa1
BLAKE2b-256 7ef896c14b56cb423da68ffd294d9290397af82f94a1bce9e289af4fbba83d80

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.239-py3-none-macosx_10_12_x86_64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.239-py3-none-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 40.6 MB
  • Tags: Python 3, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.239-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 3c29ad1bd5ac672a4c30876fb94c77ef9d4e4afc9372151e588f252fcae1d97e
MD5 a4b54c4e9baa1524e4a5be0689a8332d
BLAKE2b-256 7146311f1645b667c562548168b1cd78e9ee8191edb1e1a4cf74f6ccf5863436

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 Sentry Error logging StatusPage Status page