Skip to main content

apdb

apdb is an agent-friendly Python debugger inspired by remote-pdb. It keeps the Python call site close to pdb, but exposes debugger control over a newline-delimited JSON TCP API instead of a human interactive shell.

The runtime and CLI use only the Python standard library.

Python API

import apdb

answer = 41
apdb.set_trace(port=8888)
print(answer + 1)

set_trace() blocks the target process whether or not a client is connected. The process resumes only after the TCP API receives a release command such as continue, next, step, or quit.

By default, apdb binds to 127.0.0.1 and uses no authentication:

apdb.set_trace(port=8888, host="127.0.0.1")

CLI

The package installs apdb_cli:

apdb_cli ping --port 8888
apdb_cli state --port 8888
apdb_cli where --port 8888
apdb_cli locals --port 8888
apdb_cli history --port 8888
apdb_cli eval 'answer + 1' --port 8888
apdb_cli eval 'answer + 1' --port 8888 --output result.json
apdb_cli exec-file snippet.py --port 8888
apdb_cli exec-file snippet.py --port 8888 --output result.json
apdb_cli next --port 8888
apdb_cli step --port 8888
apdb_cli continue --port 8888

The CLI prints one JSON response to stdout and exits nonzero for connection failures or API errors.

TCP API

The TCP API speaks newline-delimited JSON. Each request and response is one JSON object followed by \n.

Request:

{"id": 1, "cmd": "state"}

Response:

{"id": 1, "ok": true, "result": {"status": "paused"}}

Supported v0 commands:

  • ping
  • state
  • where
  • locals
  • history
  • eval
  • exec
  • next
  • step
  • continue
  • quit

history returns the current set_trace() session's API operation history. Entries include sequence number, request id, command, success flag, error code for failed commands, and compact eval/exec input summaries.

Security

apdb has no authentication in v0. Debugger access can inspect and evaluate code inside the target process. Bind to 127.0.0.1 unless you explicitly want to expose that control surface.

Agent Skill

This repository includes a bundled agent skill at skills/apdb/SKILL.md. Install that skill through apdb_cli when you want a coding agent to remember the apdb workflow.

Codex:

apdb_cli skills install --agent codex --scope user
apdb_cli skills install --agent codex --scope project

Claude Code:

apdb_cli skills install --agent claude-code --scope user
apdb_cli skills install --agent claude-code --scope project

Both:

apdb_cli skills install --agent all --scope user
apdb_cli skills install --agent all --scope project

Use --force to overwrite an existing installed skill. --scope global is an alias for --scope user.

Download files

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

Source Distribution

apdb-0.1.5.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

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

apdb-0.1.5-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file apdb-0.1.5.tar.gz.

File metadata

  • Download URL: apdb-0.1.5.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for apdb-0.1.5.tar.gz
Algorithm Hash digest
SHA256 e719fe91d6ee1f325583f778dfd561190fb0ba463a290bb5dc6087160e375073
MD5 5e07fdec32e8febcfe5df1b8243d09cc
BLAKE2b-256 54700605d0f2e65a82c888ffd563b6d00136580bbea0b9e72bd6d79110ea5e42

See more details on using hashes here.

File details

Details for the file apdb-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: apdb-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for apdb-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 63a06918a7dd1de9496398733356ede509bc0dbe7990398ec3ea3e9578bf950e
MD5 50d4105c87ca20a219a17e9674805f63
BLAKE2b-256 437623bbc3e2dd944c72aa521b7e58df776570c8e48e42b4ab9e8110fa536636

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.5 This release

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

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