debug-dojo 0.4.0__tar.gz → 0.4.1__tar.gz

{debug_dojo-0.4.0 → debug_dojo-0.4.1}/.gitignore

@@ -206,3 +206,4 @@ __marimo__/
 .idea/
 .vscode/
 .DS_Store
+junit/test-results.xml

{debug_dojo-0.4.0 → debug_dojo-0.4.1}/PKG-INFO

@@ -1,14 +1,13 @@
 Metadata-Version: 2.4
 Name: debug-dojo
-Version: 0.4.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
-Project-URL: Source, https://github.com/bwrob/debug-dojo/tree/main/src/debug_dojo
+Version: 0.4.1
+Summary: 🏣 Debugging dojo for Python developers
+Project-URL: Homepage, https://bwrob.github.io/debug-dojo/
+Project-URL: Documentation, https://bwrob.github.io/debug-dojo/
+Project-URL: Source, https://github.com/bwrob/debug-dojo/
 Project-URL: Changelog, https://github.com/bwrob/debug-dojo/blob/main/HISTORY.md
 Author-email: bwrob <bartosz.marcin.wroblewski@gmail.com>
 License-Expression: MIT
-License-File: LICENSE
 Keywords: debugging,inspection,pudb,rich,tools,traceback
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -20,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Debuggers
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.10
+Requires-Python: <3.14,>=3.10
 Requires-Dist: debugpy>=1.8.0
 Requires-Dist: ipdb>=0.13.0
 Requires-Dist: pudb>=2020.1
@@ -30,8 +29,10 @@ Requires-Dist: tomlkit>=0.13.3
 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_python.png?raw=true" alt="debug dojo" style="width:50%; max-width:300px;"/>
+  <img src="https://github.com/bwrob/debug-dojo/blob/main/docs/logo/logo_python.png?raw=true" alt="debug dojo" style="width:50%; max-width:300px;"/>
 </p>
 
 <p align="center">
@@ -41,21 +42,10 @@ Description-Content-Type: text/markdown
 [![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. 
+[**debug-dojo**](https://bwrob.github.io/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 different debuggers -- `debugpy`, `pudb`, `pdb`, and `ipdb`.
 
-## Features
-
-- **Convenient CLI** Quickly run your code with debugging tools enabled.
-- **Simple API:** Install all tools or only what you need.
-- **Debugger integration:** Quickly enable Debugpy, PuDB, PDB, or IPDB as your default pre-configured 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.
-- **Configuration:** Easily configure the debugging tools using `dojo.toml` or `pyproject.toml`.
-
-## Usage
-
-### CLI
+## CLI usage
 
 Run your Python script with debugging tools enabled using the `debug-dojo` command:
 
@@ -69,7 +59,7 @@ You can optionally set configuration, verbose mode, and specify the debugger typ
 dojo --debugger ipdb --config dojo.toml --verbose --module my_module
 ```
 
-### From the code
+## From the code
 
 In the `PuDB` style, you can install all debugging tools and enter the debugging mode with a single command:
 
@@ -78,84 +68,27 @@ 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
-```
-
-### Features in debugging mode
-
-The following functions are available in the debugging mode, injected into builtins:
-
-- `b()` is a hook that sets a breakpoint using the configured debugger.
-- `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.
-
-## Configuration
-
-You can configure the debugging tools using a `dojo.toml` or `pyproject.toml` file. The configuration allows you to specify which debugger to use, enable or disable features, and set other options.
-
-**Example `dojo.toml`:**
-
-```toml
-[debuggers]
-    default = "ipdb"
-
-    debugpy = { port = 1992 }
-    ipdb    = { context_lines = 20 }
-
-[exceptions]
-    locals_in_traceback = false
-    post_mortem         = true
-    rich_traceback      = true
-
-[features]
-    breakpoint   = "b"
-    # Empty string means disable the feature
-    comparer     = ""
-    rich_inspect = "i"
-    rich_print   = "p"
-```
-
-## Installation
 
-The package is available on PyPI and can be installed using standard Python package management tools.
+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.
 
-```console
-pip install debug-dojo
 ```
 
-You can also use `poetry` or `uv` to add it to your project:
-
-```console
-poetry add debug-dojo
-```
+## Documentation
 
-```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
-
-```console
-ruff check src/debug_dojo --fix
-basedpyright src/debug_dojo
-
-poe code-quality
-```
+For instructions regarding installation, configuration and usage please visit [documentation](https://bwrob.github.io/debug-dojo/).
+# Changelog
 
-### Tests
+## v0.4.1 (2025-08-10)
 
-TBA
+*release tag*: [v0.4.1](https://github.com/bwrob/debug-dojo/releases/tag/v0.4.1)
 
-## Changelog
+- Mkdocs documentation at [debug dojo](https://bwrob.github.io/debug-dojo).
 
 ## v0.4.0 (2025-08-10)
 
-*release tag*: [v0.4.0]
+*release tag*: [v0.4.0](https://github.com/bwrob/debug-dojo/releases/tag/v0.4.0)
 
 - New configuration model `DebugDojoConfig` for better structure.
 - Added support for `debugger` configuration in `dojo.toml`.
@@ -166,7 +99,7 @@ TBA
 
 ## v0.3.2 (2025-07-28)
 
-*release tag*: [v0.3.2]
+*release tag*: [v0.3.2](https://github.com/bwrob/debug-dojo/releases/tag/v0.3.2)
 
 - New logo for the project.
 - Typer used for CLI implementation.
@@ -176,7 +109,7 @@ TBA
 
 ## v0.2.0 (2025-07-20)
 
-*release tag*: [v0.2.0]
+*release tag*: [v0.2.0](https://github.com/bwrob/debug-dojo/releases/tag/v0.2.0)
 
 - Added `dojo` command for easy debugging setup.
 - Added `p()` function for rich printing.
@@ -186,7 +119,7 @@ TBA
 
 ## v0.1.0 (2025-07-19)
 
-*release tag*: [v0.1.0]
+*release tag*: [v0.1.0](https://github.com/bwrob/debug-dojo/releases/tag/v0.1.0)
 
 - Initial module to install debugging tools.
 - Debug mode utilities for PuDB, rich tracebacks, and object inspection.

debug_dojo-0.4.1/README.md

@@ -0,0 +1,49 @@
+# debug dojo
+
+<p align="center">
+  <img src="https://github.com/bwrob/debug-dojo/blob/main/docs/logo/logo_python.png?raw=true" alt="debug dojo" style="width:50%; max-width:300px;"/>
+</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**](https://bwrob.github.io/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 different debuggers -- `debugpy`, `pudb`, `pdb`, and `ipdb`.
+
+## CLI usage
+
+Run your Python script with debugging tools enabled using the `debug-dojo` command:
+
+```console
+dojo my_script.py
+```
+
+You can optionally set configuration, verbose mode, and specify the debugger type. Both script files and modules are supported:
+
+```console
+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:
+
+```python
+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](https://bwrob.github.io/debug-dojo/).

{debug_dojo-0.4.0 → debug_dojo-0.4.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
     name = "debug-dojo"
-    description = "Debbugging dojo for Python developers"
+    description = "🏣 Debugging dojo for Python developers"
     authors = [
         { name = "bwrob", email = "bartosz.marcin.wroblewski@gmail.com" },
     ]
-    requires-python = ">=3.10"
+    requires-python = ">=3.10,<3.14"
     dependencies = [
         "debugpy>=1.8.0",
         "ipdb>=0.13.0",
@@ -36,13 +36,13 @@
         "Topic :: Software Development :: Debuggers",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ]
-    version = "0.4.0"
+    version = "0.4.1"
     dynamic = ['readme']
 
     [project.urls]
-        Homepage      = "https://github.com/bwrob/debug-dojo"
-        Documentation = "https://github.com/bwrob/debug-dojo/blob/main/README.md"
-        Source        = "https://github.com/bwrob/debug-dojo/tree/main/src/debug_dojo"
+        Homepage      = "https://bwrob.github.io/debug-dojo/"
+        Documentation = "https://bwrob.github.io/debug-dojo/"
+        Source        = "https://github.com/bwrob/debug-dojo/"
         Changelog     = "https://github.com/bwrob/debug-dojo/blob/main/HISTORY.md"
 
     [project.scripts]
@@ -50,11 +50,20 @@
 
 [dependency-groups]
     dev = [
-        "basedpyright>=1.31.0",
-        "jupyter>=1.1.1",
-        "poethepoet>=0.36.0",
-        "ruff>=0.12.4",
+        "basedpyright>=1.31.2",
+        "poethepoet>=0.37.0",
+        "pytest>=8.4.1",
+        "ruff>=0.12.9",
     ]
+    docs = [
+        "mkdocs>=1.6.1",
+        "mkdocs-git-authors-plugin>=0.10.0",
+        "mkdocs-git-committers-plugin-2>=2.5.0",
+        "mkdocs-git-revision-date-localized-plugin>=1.4.7",
+        "mkdocs-material>=9.6.17",
+        "mkdocs-typer2>=0.1.5",
+        "mkdocstrings-python>=1.17.0",
+]
 
 [build-system]
     requires = [
@@ -63,6 +72,9 @@
     ]
     build-backend = "hatchling.build"
 
+[tool.uv]
+    required-version = ">=0.8.0"
+
 [tool.hatch.metadata]
     allow-direct-references = true
 
@@ -71,8 +83,7 @@
         # construct the PyPI readme from README.md and HISTORY.md
         fragments = [
             { path = 'README.md' },
-            { text = "\n\n## Changelog\n\n" },
-            { path = 'HISTORY.md' },
+            { path = './docs/changelog.md' },
         ]
 
 
@@ -88,15 +99,3 @@
     pythonVersion    = "3.10"
     strict           = ["src/debug_dojo/*"]
     ignore           = ["examples"]
-
-[tool.poe.tasks]
-    lint = "ruff check --fix src"
-    format = "ruff format src"
-    type-check = "basedpyright --project pyproject.toml src/debug_dojo"
-    code-quality = ["format", "lint", "type-check"]
-    publish = [
-        "code-quality",
-        { cmd = "rm -rf dist" },
-        { cmd = "uv build" },
-        { cmd = "uv publish" },
-    ]

{debug_dojo-0.4.0 → debug_dojo-0.4.1}/src/debug_dojo/_installers.py

@@ -96,17 +96,40 @@ def _inspect() -> None:
 
 
 def _compare() -> None:
-    """Print the object using a custom inspect function."""
+    """Print the object using a custom inspect function.
+
+    >>> _compare()
+    >>> import builtins
+    >>> callable(builtins.c)
+    True
+
+    """
     builtins.c = inspect_objects_side_by_side  # pyright: ignore[reportAttributeAccessIssue]
 
 
 def _breakpoint() -> None:
-    """Install the breakpoint function."""
+    """Install the breakpoint function.
+
+    >>> _breakpoint()
+    >>> import builtins
+    >>> callable(builtins.b)
+    True
+
+    """
     builtins.b = breakpoint  # pyright: ignore[reportAttributeAccessIssue]
 
 
 def _rich_print() -> None:
-    """Install the print from rich."""
+    """Install the print from rich.
+
+    >>> _rich_print()
+    >>> import builtins
+    >>> callable(builtins.p)
+    True
+    >>> p("test")
+    test
+
+    """
     from rich import print as rich_print
 
     builtins.p = rich_print  # pyright: ignore[reportAttributeAccessIssue]

debug_dojo-0.4.0/HISTORY.md

@@ -1,37 +0,0 @@
-## 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.

debug_dojo-0.4.0/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 to bwrob.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

debug_dojo-0.4.0/README.md

@@ -1,120 +0,0 @@
-<p align="center">
-  <img src="https://github.com/bwrob/debug-dojo/blob/main/logo/logo_python.png?raw=true" alt="debug dojo" style="width:50%; max-width:300px;"/>
-</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 different debuggers -- `debugpy`, `pudb`, `pdb`, and `ipdb`.
-
-## Features
-
-- **Convenient CLI** Quickly run your code with debugging tools enabled.
-- **Simple API:** Install all tools or only what you need.
-- **Debugger integration:** Quickly enable Debugpy, PuDB, PDB, or IPDB as your default pre-configured 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.
-- **Configuration:** Easily configure the debugging tools using `dojo.toml` or `pyproject.toml`.
-
-## Usage
-
-### CLI
-
-Run your Python script with debugging tools enabled using the `debug-dojo` command:
-
-```console
-dojo my_script.py
-```
-
-You can optionally set configuration, verbose mode, and specify the debugger type. Both script files and modules are supported:
-
-```console
-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:
-
-```python
-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
-```
-
-### Features in debugging mode
-
-The following functions are available in the debugging mode, injected into builtins:
-
-- `b()` is a hook that sets a breakpoint using the configured debugger.
-- `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.
-
-## Configuration
-
-You can configure the debugging tools using a `dojo.toml` or `pyproject.toml` file. The configuration allows you to specify which debugger to use, enable or disable features, and set other options.
-
-**Example `dojo.toml`:**
-
-```toml
-[debuggers]
-    default = "ipdb"
-
-    debugpy = { port = 1992 }
-    ipdb    = { context_lines = 20 }
-
-[exceptions]
-    locals_in_traceback = false
-    post_mortem         = true
-    rich_traceback      = true
-
-[features]
-    breakpoint   = "b"
-    # Empty string means disable the feature
-    comparer     = ""
-    rich_inspect = "i"
-    rich_print   = "p"
-```
-
-## Installation
-
-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
-
-```console
-ruff check src/debug_dojo --fix
-basedpyright src/debug_dojo
-
-poe code-quality
-```
-
-### Tests
-
-TBA