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 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.243)

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.243.dev202608232305-py3-none-win_amd64.whl (52.2 MB view details)

Uploaded Python 3Windows x86-64

codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-musllinux_1_1_x86_64.whl (47.4 MB view details)

Uploaded Python 3musllinux: musl 1.1+ x86-64

codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-musllinux_1_1_aarch64.whl (47.2 MB view details)

Uploaded Python 3musllinux: musl 1.1+ ARM64

codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-manylinux_2_17_x86_64.whl (49.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-manylinux_2_17_aarch64.whl (48.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-macosx_11_0_arm64.whl (37.8 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-macosx_10_12_x86_64.whl (40.4 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-win_amd64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-win_amd64.whl
  • Upload date:
  • Size: 52.2 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.243.dev202608232305-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 ada935a906155d5bdd4841c6e598604473a504fed2bc06ad7283ad3a932c6e53
MD5 38614c746ad393a394979b46727ffcda
BLAKE2b-256 db32cb37764f9b13648291ffd803305113333af1236ad24baa9989e26468098a

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-musllinux_1_1_x86_64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-musllinux_1_1_x86_64.whl
  • Upload date:
  • Size: 47.4 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.243.dev202608232305-py3-none-musllinux_1_1_x86_64.whl
Algorithm Hash digest
SHA256 aa8cc2265cfb5e0016bfd7bbbbfd6ecd3ee96c8cdf5ddaa1681f1d62e17108f5
MD5 3a6f59d156f45f2ad6ef61b62c4e7d0f
BLAKE2b-256 db3f5bb029a3094dd6de247779c1711c6e3cfaecab86ada23a5b4d33bbc59fac

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-musllinux_1_1_aarch64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-musllinux_1_1_aarch64.whl
  • Upload date:
  • Size: 47.2 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.243.dev202608232305-py3-none-musllinux_1_1_aarch64.whl
Algorithm Hash digest
SHA256 957fe8ff4d8a9772041e613e6e826dde53b3749f39d91ac1546da04b7c501631
MD5 568e68a3f88fec2585a039985c1b8809
BLAKE2b-256 4df831541d8224091a6490f2e67889044e62985615621c18ccf68b448021a0ef

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-manylinux_2_17_x86_64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-manylinux_2_17_x86_64.whl
  • Upload date:
  • Size: 49.0 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.243.dev202608232305-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 2f59b705df94dd75943615bf819dfbab546714e4e9f6c112ac896e81430cd172
MD5 bf0586e7aba857d6359bf512c1d8427a
BLAKE2b-256 812b20e6c649faee1af843d5f4a38ea78b4e561865a9f5ddbfaff52c96a5f818

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-manylinux_2_17_aarch64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-manylinux_2_17_aarch64.whl
  • Upload date:
  • Size: 48.6 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.243.dev202608232305-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 8fa935111a27da7f676f313f03a4128448fc51aa9d220e3ebf4aa905d6b82401
MD5 3eab9dfb27816eb157c7307fd8aea5ae
BLAKE2b-256 c66df85430c566b4569d7e1a75e16f1acb1a9f8be47f9bc9f9cc549fe6a8e295

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-macosx_11_0_arm64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 37.8 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.243.dev202608232305-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d2c736f7efcfe54320b567f96ea15bfd7bcea19637d63d2510bd60eab5564621
MD5 88d24328037e60cce38d568da925e648
BLAKE2b-256 d8a87f7ea7253cb078ca2e9f4eb4f2b2fa32aff1d4bdeb87deb29a540e5749c2

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-macosx_10_12_x86_64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243.dev202608232305-py3-none-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 40.4 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.243.dev202608232305-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 da6a4bf51a59e58c1c5df5fabdc7a3b6f87a9925d9e7e4692bbb7fe0c7fb0fa4
MD5 3bdf7ce1205371c944c7537d5a5ae2e3
BLAKE2b-256 e6ac52894c560638c0aa4688149a780e089a4e01a1de228c73ca8cdfc7e9f38f

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.243

7 files

This release
Pre-release

0.3.243.dev202608232305 This release

7 files

0.3.236

7 files

0.3.227

7 files

0.3.221

7 files

0.3.219

7 files

0.3.215

7 files

0.3.205

7 files

0.3.202

7 files

0.3.195

7 files

0.3.189

7 files

0.3.187

7 files

0.3.178

7 files

0.3.176

7 files

0.3.174

7 files

0.3.168

7 files

0.3.167

7 files

0.3.162

7 files

0.3.160

7 files

0.3.149

7 files

0.3.134

7 files

0.3.119

7 files

0.3.109

7 files

0.3.99

7 files

0.3.89

7 files

0.2.3

7 files

Yanked

0.1.19

4 files

Yanked

0.1.18

4 files

Yanked

0.1.17

4 files

Yanked

0.1.16

4 files

Yanked

0.1.15

4 files

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page