debug-dojo 0.2.0__tar.gz → 0.3.0__tar.gz

{debug_dojo-0.2.0 → debug_dojo-0.3.0}/HISTORY.md

@@ -1,6 +1,6 @@
 ## v0.2.0 (2025-07-20)
 
-*release tag*: [v0.2.0](https://github.com/pydantic/pydantic/releases/tag/v2.11.6)
+*release tag*: [v0.2.0]
 
 ### What's Changed
 
@@ -13,9 +13,9 @@
 
 - Fixed `pyproject.toml` to point to GitHub repository as the homepage.
 
-## v0.1.0 (2025-07-20)
+## v0.1.0 (2025-07-19)
 
-*release tag*: [v0.1.0](https://github.com/pydantic/pydantic/releases/tag/v2.11.6)
+*release tag*: [v0.1.0]
 
 ### What's Changed
 

{debug_dojo-0.2.0 → debug_dojo-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: debug-dojo
-Version: 0.2.0
+Version: 0.3.0
 Summary: Debbugging dojo for Python developers
 Project-URL: Homepage, https://github.com/bwrob/debug-dojo
 Project-URL: Documentation, https://github.com/bwrob/debug-dojo/blob/main/README.md
@@ -22,26 +22,39 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Requires-Dist: pudb>=2020.1
 Requires-Dist: rich>=11.0.0
+Requires-Dist: typer>=0.15.0
 Description-Content-Type: text/markdown
 
-# debug-dojo
+<p align="center">
+  <img src="https://github.com/bwrob/debug-dojo/blob/main/logo/logo_white.png?raw=true" alt="debug dojo" style="width:50%; max-width:400px;"/>
+</p>
+
+<p align="center">
+    <em>debug dojo, a place for zen debugging</em>
+</p>
+
+[![PyPi Version](https://img.shields.io/pypi/v/debug-dojo.svg?style=flat-square)](https://pypi.org/project/debug-dojo)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/debug-dojo.svg?style=flat-square)](https://pypi.org/pypi/debug-dojo/)
 
 **debug-dojo** is a Python package providing utilities for enhanced debugging and inspection in the terminal. It leverages [`rich`](https://github.com/Textualize/rich) for beautiful output and offers helpers for side-by-side object comparison, improved tracebacks from `rich`, and easy integration with PuDB. All tools can be installed at once or individually, allowing for flexible debugging setups.
 
 ## Features
 
+- **Convenient CLI** Quickly run your code with debugging tools enabled.
 - **Simple API:** Install all tools or only what you need.
 - **PuDB integration:** Quickly enable the PuDB TUI debugger.
 - **Rich tracebacks:** Get readable, colorized tracebacks for easier debugging.
 - **Side-by-side object inspection:** Visually compare Python objects, their attributes, and methods in the terminal.
 
-## Installation
+## Usage
 
-```sh
-pip install debug-dojo
-```
+### CLI
 
-## Usage
+Run your Python script with debugging tools enabled using the `debug-dojo` command:
+
+```console
+dojo my_script.py
+```
 
 ### Install all debugging tools
 
@@ -50,6 +63,7 @@ In the `PuDB` style, you can install all debugging tools and enter the debugging
 ```python
 import debug_dojo.all; b()
 
+p(object_1)  # Pretty print an object with Rich
 i(object_1)  # Inspect an object
 c(object_1, object_2)  # Compare two objects side-by-side
 ```
@@ -57,7 +71,8 @@ c(object_1, object_2)  # Compare two objects side-by-side
 Where:
 
 - `b()` is a builtin-injected function that sets a breakpoint using PuDB's `set_trace()`.
-- `i(object_1)` to inspect an object.
+- `p(object_1)` is pretty printing of an object using Rich.
+- `i(object_1)` to inspect an object using Rich.
 - `c(object_1, object_2)` to compare two objects side-by-side.
 
 ### Use individual tools
@@ -80,17 +95,32 @@ b = [1, 2, 3]
 inspect_objects_side_by_side(a, b)
 ```
 
-## Development
 
-### Run tests
+## Installation
 
-```sh
-pytest
+The package is available on PyPI and can be installed using standard Python package management tools.
+
+```console
+pip install debug-dojo
+```
+
+You can also use `poetry` or `uv` to add it to your project:
+
+```console
+poetry add debug-dojo
 ```
 
+```console
+uv add debug-dojo
+```
+
+Note that dojo most likely will not work when installed via `pipx` or `uvx`, as it relies on the current Python environment dependencies.
+
+## Development
+
 ### Lint and type check
 
-```sh
+```console
 ruff check src/debug_dojo --fix
 basedpyright src/debug_dojo
 ```
@@ -100,7 +130,7 @@ basedpyright src/debug_dojo
 
 ## v0.2.0 (2025-07-20)
 
-*release tag*: [v0.2.0](https://github.com/pydantic/pydantic/releases/tag/v2.11.6)
+*release tag*: [v0.2.0]
 
 ### What's Changed
 
@@ -113,9 +143,9 @@ basedpyright src/debug_dojo
 
 - Fixed `pyproject.toml` to point to GitHub repository as the homepage.
 
-## v0.1.0 (2025-07-20)
+## v0.1.0 (2025-07-19)
 
-*release tag*: [v0.1.0](https://github.com/pydantic/pydantic/releases/tag/v2.11.6)
+*release tag*: [v0.1.0]
 
 ### What's Changed
 

{debug_dojo-0.2.0 → debug_dojo-0.3.0}/README.md

@@ -1,21 +1,33 @@
-# debug-dojo
+<p align="center">
+  <img src="https://github.com/bwrob/debug-dojo/blob/main/logo/logo_white.png?raw=true" alt="debug dojo" style="width:50%; max-width:400px;"/>
+</p>
+
+<p align="center">
+    <em>debug dojo, a place for zen debugging</em>
+</p>
+
+[![PyPi Version](https://img.shields.io/pypi/v/debug-dojo.svg?style=flat-square)](https://pypi.org/project/debug-dojo)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/debug-dojo.svg?style=flat-square)](https://pypi.org/pypi/debug-dojo/)
 
 **debug-dojo** is a Python package providing utilities for enhanced debugging and inspection in the terminal. It leverages [`rich`](https://github.com/Textualize/rich) for beautiful output and offers helpers for side-by-side object comparison, improved tracebacks from `rich`, and easy integration with PuDB. All tools can be installed at once or individually, allowing for flexible debugging setups.
 
 ## Features
 
+- **Convenient CLI** Quickly run your code with debugging tools enabled.
 - **Simple API:** Install all tools or only what you need.
 - **PuDB integration:** Quickly enable the PuDB TUI debugger.
 - **Rich tracebacks:** Get readable, colorized tracebacks for easier debugging.
 - **Side-by-side object inspection:** Visually compare Python objects, their attributes, and methods in the terminal.
 
-## Installation
+## Usage
 
-```sh
-pip install debug-dojo
-```
+### CLI
 
-## Usage
+Run your Python script with debugging tools enabled using the `debug-dojo` command:
+
+```console
+dojo my_script.py
+```
 
 ### Install all debugging tools
 
@@ -24,6 +36,7 @@ In the `PuDB` style, you can install all debugging tools and enter the debugging
 ```python
 import debug_dojo.all; b()
 
+p(object_1)  # Pretty print an object with Rich
 i(object_1)  # Inspect an object
 c(object_1, object_2)  # Compare two objects side-by-side
 ```
@@ -31,7 +44,8 @@ c(object_1, object_2)  # Compare two objects side-by-side
 Where:
 
 - `b()` is a builtin-injected function that sets a breakpoint using PuDB's `set_trace()`.
-- `i(object_1)` to inspect an object.
+- `p(object_1)` is pretty printing of an object using Rich.
+- `i(object_1)` to inspect an object using Rich.
 - `c(object_1, object_2)` to compare two objects side-by-side.
 
 ### Use individual tools
@@ -54,17 +68,32 @@ b = [1, 2, 3]
 inspect_objects_side_by_side(a, b)
 ```
 
-## Development
 
-### Run tests
+## Installation
 
-```sh
-pytest
+The package is available on PyPI and can be installed using standard Python package management tools.
+
+```console
+pip install debug-dojo
+```
+
+You can also use `poetry` or `uv` to add it to your project:
+
+```console
+poetry add debug-dojo
 ```
 
+```console
+uv add debug-dojo
+```
+
+Note that dojo most likely will not work when installed via `pipx` or `uvx`, as it relies on the current Python environment dependencies.
+
+## Development
+
 ### Lint and type check
 
-```sh
+```console
 ruff check src/debug_dojo --fix
 basedpyright src/debug_dojo
 ```

{debug_dojo-0.2.0 → debug_dojo-0.3.0}/pyproject.toml

@@ -5,7 +5,11 @@
         { name = "bwrob", email = "bartosz.marcin.wroblewski@gmail.com" },
     ]
     requires-python = ">=3.10"
-    dependencies = ["pudb>=2020.1", "rich>=11.0.0"]
+    dependencies = [
+        "pudb>=2020.1",
+        "rich>=11.0.0",
+        "typer>=0.15.0",
+    ]
     license = 'MIT'
     license-files = ['LICENSE']
     keywords = [
@@ -28,7 +32,8 @@
         "Topic :: Software Development :: Debuggers",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ]
-    dynamic = ['readme', 'version']
+    version = "0.3.0"
+    dynamic = ['readme']
 
     [project.urls]
         Homepage      = "https://github.com/bwrob/debug-dojo"
@@ -39,7 +44,7 @@
     [project.scripts]
         # This defines your command-line script!
         # It points to the 'main' function in your 'cli' module.
-        "dojo" = "debug_dojo.cli:main"
+        "dojo" = "debug_dojo._cli:main"
 
 [dependency-groups]
     dev = ["basedpyright>=1.31.0", "ruff>=0.12.4"]

debug_dojo-0.3.0/src/debug_dojo/_cli.py

@@ -0,0 +1,76 @@
+"""Command-line interface for running Python scripts or modules with debugging tools."""
+
+import os
+import runpy
+import sys
+from bdb import BdbQuit
+from pathlib import Path
+from typing import Annotated
+
+import typer
+from rich import print as rich_print
+
+from .installers import install_all
+
+cli = typer.Typer(
+    name="debug_dojo",
+    help="Run a Python script or module with debugging tools installed.",
+    no_args_is_help=True,
+)
+
+
+def execute_with_debug(target_name: str, args_for_target: list[str]) -> None:
+    """Execute a target script or module with installation of debugging tools."""
+    sys.argv = [target_name, *args_for_target]
+
+    install_all()
+
+    if (
+        Path(target_name).exists()
+        or target_name.endswith(".py")
+        or os.sep in target_name
+    ):
+        if not Path(target_name).exists():
+            sys.exit(1)
+        runner = runpy.run_path
+    else:
+        runner = runpy.run_module
+
+    _ = runner(target_name, run_name="__main__")
+
+
+@cli.command(
+    name="",
+    context_settings={
+        "allow_extra_args": True,
+        "ignore_unknown_options": True,
+    },
+)
+def main(
+    ctx: typer.Context,
+    target_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            help="The target script or module to debug. Provide the path or module name.",
+        ),
+    ],
+) -> None:
+    """Run the command-line interface."""
+    args_for_target = ctx.args
+    try:
+        execute_with_debug(target_name, args_for_target)
+    except BdbQuit:
+        rich_print("[red]Debugging session terminated by user.[/red]")
+        sys.exit(0)
+
+
+@cli.command("config")
+def config() -> None:
+    """Display the configuration for the debug dojo."""
+    rich_print("[green]Debug Dojo Configuration:[/green]")
+    rich_print("This tool installs debugging tools and runs Python scripts or modules.")
+    rich_print(
+        "You can specify a target script or module to debug, along with any arguments."
+    )
+    rich_print("Example usage: `debug_dojo target_to_debug.py --some-input-to-target`")

{debug_dojo-0.2.0 → debug_dojo-0.3.0}/src/debug_dojo/installers.py

@@ -66,8 +66,7 @@ def install_breakpoint() -> None:
 
 
 def install_rich_print() -> None:
-    """Install the breakpoint function."""
-    # Set the breakpoint function to use PuDB's set_trace
+    """Install the print from rich."""
     builtins.p = rich_print  # pyright: ignore[reportAttributeAccessIssue]
 
 

{debug_dojo-0.2.0 → debug_dojo-0.3.0}/uv.lock

@@ -14,6 +14,18 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/5a/85/cb46707458c514ae959fe139135d8f7231d95faf1c383a56979a3436b965/basedpyright-1.31.0-py3-none-any.whl", hash = "sha256:d7460ddcd3a2332b1c3fd738735d18bf2966d49aed67237efa1f19635199d414", size = 11538999, upload-time = "2025-07-16T11:37:26.446Z" },
 ]
 
+[[package]]
+name = "click"
+version = "8.2.1"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "colorama", marker = "sys_platform == 'win32'" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/60/6c/8ca2efa64cf75a977a0d7fac081354553ebe483345c734fb6b6515d96bbc/click-8.2.1.tar.gz", hash = "sha256:27c491cc05d968d271d5a1db13e3b5a184636d9d930f148c50b038f0d0646202", size = 286342, upload-time = "2025-05-20T23:19:49.832Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/85/32/10bb5764d90a8eee674e9dc6f4db6a0ab47c8c4d0d83c27f7c39ac415a4d/click-8.2.1-py3-none-any.whl", hash = "sha256:61a3265b914e850b85317d0b3109c7f8cd35a670f963866005d6ef1d5175a12b", size = 102215, upload-time = "2025-05-20T23:19:47.796Z" },
+]
+
 [[package]]
 name = "colorama"
 version = "0.4.6"
@@ -34,10 +46,12 @@ wheels = [
 
 [[package]]
 name = "debug-dojo"
+version = "0.3.0"
 source = { editable = "." }
 dependencies = [
     { name = "pudb" },
     { name = "rich" },
+    { name = "typer" },
 ]
 
 [package.dev-dependencies]
@@ -50,6 +64,7 @@ dev = [
 requires-dist = [
     { name = "pudb", specifier = ">=2020.1" },
     { name = "rich", specifier = ">=11.0.0" },
+    { name = "typer", specifier = ">=0.15.0" },
 ]
 
 [package.metadata.requires-dev]
@@ -168,6 +183,39 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/11/02/8857d0dfb8f44ef299a5dfd898f673edefb71e3b533b3b9d2db4c832dd13/ruff-0.12.4-py3-none-win_arm64.whl", hash = "sha256:0618ec4442a83ab545e5b71202a5c0ed7791e8471435b94e655b570a5031a98e", size = 10469336, upload-time = "2025-07-17T17:27:16.913Z" },
 ]
 
+[[package]]
+name = "shellingham"
+version = "1.5.4"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/58/15/8b3609fd3830ef7b27b655beb4b4e9c62313a4e8da8c676e142cc210d58e/shellingham-1.5.4.tar.gz", hash = "sha256:8dbca0739d487e5bd35ab3ca4b36e11c4078f3a234bfce294b0a0291363404de", size = 10310, upload-time = "2023-10-24T04:13:40.426Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/e0/f9/0595336914c5619e5f28a1fb793285925a8cd4b432c9da0a987836c7f822/shellingham-1.5.4-py2.py3-none-any.whl", hash = "sha256:7ecfff8f2fd72616f7481040475a65b2bf8af90a56c89140852d1120324e8686", size = 9755, upload-time = "2023-10-24T04:13:38.866Z" },
+]
+
+[[package]]
+name = "typer"
+version = "0.16.0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "click" },
+    { name = "rich" },
+    { name = "shellingham" },
+    { name = "typing-extensions" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/c5/8c/7d682431efca5fd290017663ea4588bf6f2c6aad085c7f108c5dbc316e70/typer-0.16.0.tar.gz", hash = "sha256:af377ffaee1dbe37ae9440cb4e8f11686ea5ce4e9bae01b84ae7c63b87f1dd3b", size = 102625, upload-time = "2025-05-26T14:30:31.824Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/76/42/3efaf858001d2c2913de7f354563e3a3a2f0decae3efe98427125a8f441e/typer-0.16.0-py3-none-any.whl", hash = "sha256:1f79bed11d4d02d4310e3c1b7ba594183bcedb0ac73b27a9e5f28f6fb5b98855", size = 46317, upload-time = "2025-05-26T14:30:30.523Z" },
+]
+
+[[package]]
+name = "typing-extensions"
+version = "4.14.1"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/98/5a/da40306b885cc8c09109dc2e1abd358d5684b1425678151cdaed4731c822/typing_extensions-4.14.1.tar.gz", hash = "sha256:38b39f4aeeab64884ce9f74c94263ef78f3c22467c8724005483154c26648d36", size = 107673, upload-time = "2025-07-04T13:28:34.16Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/b5/00/d631e67a838026495268c2f6884f3711a15a9a2a96cd244fdaea53b823fb/typing_extensions-4.14.1-py3-none-any.whl", hash = "sha256:d1e1e3b58374dc93031d6eda2420a48ea44a36c2b4766a4fdeb3710755731d76", size = 43906, upload-time = "2025-07-04T13:28:32.743Z" },
+]
+
 [[package]]
 name = "urwid"
 version = "3.0.2"

debug_dojo-0.2.0/src/debug_dojo/cli.py

@@ -1,49 +0,0 @@
-"""Command-line interface for running Python scripts or modules with debugging tools."""
-
-import os
-import runpy
-import sys
-from bdb import BdbQuit
-from pathlib import Path
-
-from rich import print as rich_print
-
-from .installers import install_all
-
-
-def execute_with_debug(target_name: str, args_for_target: list[str]) -> None:
-    """Execute a target script or module with installation of debugging tools."""
-    sys.argv = [target_name, *args_for_target]
-
-    install_all()
-
-    if (
-        Path(target_name).exists()
-        or target_name.endswith(".py")
-        or os.sep in target_name
-    ):
-        if not Path(target_name).exists():
-            sys.exit(1)
-        runner = runpy.run_path
-    else:
-        runner = runpy.run_module
-
-    _ = runner(target_name, run_name="__main__")
-
-
-def main() -> None:
-    """Run the command-line interface."""
-    if len(sys.argv) < 2:
-        rich_print(
-            "[red]No target specified. Example usage: \n"
-            + "dojo target_to_debug.py --some-input-to-target[/red]"
-        )
-        sys.exit(1)
-
-    target_name = sys.argv[1]
-    args_for_target = sys.argv[2:]
-    try:
-        execute_with_debug(target_name, args_for_target)
-    except BdbQuit:
-        rich_print("[red]Debugging session terminated by user.[/red]")
-        sys.exit(0)

debug_dojo-0.2.0/src/debug_dojo/version.py

@@ -1,3 +0,0 @@
-"""The `version` module holds the version information for debug-dojo."""
-
-VERSION = "0.2.0"