debug-dojo 0.4.1

🏣 Debugging dojo for Python developers

debug dojo

debug dojo, a place for zen debugging

debug-dojo is a Python package providing utilities for enhanced debugging and inspection in the terminal. It leverages rich for beautiful output and offers helpers for side-by-side object comparison, improved tracebacks from rich, and easy integration with different debuggers -- debugpy, pudb, pdb, and ipdb.

CLI usage

Run your Python script with debugging tools enabled using the debug-dojo command:

dojo my_script.py

You can optionally set configuration, verbose mode, and specify the debugger type. Both script files and modules are supported:

dojo --debugger ipdb --config dojo.toml --verbose --module my_module

From the code

In the PuDB style, you can install all debugging tools and enter the debugging mode with a single command:

object_1 = {"foo": 1, "bar": 2}
object_2 = [1, 2, 3]

import debug_dojo.install; b()

p(object_1)             # Pretty print an object with Rich.
i(object_1)             # Inspect an object using Rich.
c(object_1, object_2)   # Compare two objects side-by-side.

Documentation

For instructions regarding installation, configuration and usage please visit documentation.

Changelog

v0.4.1 (2025-08-10)

release tag: v0.4.1

• Mkdocs documentation at debug dojo.

v0.4.0 (2025-08-10)

release tag: v0.4.0

• New configuration model DebugDojoConfig for better structure.
• Added support for debugger configuration in dojo.toml.
• Updated dojo command to include debugger type in command call.
• Configuration versioning allows for in-flight migration of old configurations.
• Improved error handling in configuration loading.
• Improved catching errors from target execution.

v0.3.2 (2025-07-28)

release tag: v0.3.2

• New logo for the project.
• Typer used for CLI implementation.
• Dojo is configured via dojo.toml or pyproject.toml.
• Support for debugpy and ipdb for debugging.
• Fixed documentation and history.

v0.2.0 (2025-07-20)

release tag: v0.2.0

• Added dojo command for easy debugging setup.
• Added p() function for rich printing.
• Added history file for tracking changes.
• Moved to hatch for building and packaging.
• Fixed pyproject.toml to point to GitHub repository as the homepage.

v0.1.0 (2025-07-19)

release tag: v0.1.0

• Initial module to install debugging tools.
• Debug mode utilities for PuDB, rich tracebacks, and object inspection.