robotframework-debuglibrary

What it is and what it does

DebugLibrary is a debug library for Robot Framework that adds interactive debugging capabilities to test execution. It provides two main modes: embedding Debug or Debug If keywords in test files to pause execution and drop into an interactive shell, or running the standalone rfdebug command to use Robot Framework as an interactive REPL. The library depends on prompt-toolkit for terminal interaction and Robot Framework itself.

The interactive shell supports keyword auto-completion, command history (saved to ~/.rfdebug_history), and step-through debugging similar to pdb—allowing developers to trace test execution line-by-line, inspect variables, and execute Robot Framework keywords on demand. It's useful during test development and troubleshooting, though step debugging does not currently support FOR loops.

Use it for:

• Pause test execution mid-run to inspect variable state and test environment interactively.
• Explore available Robot Framework keywords and libraries in a live shell without running full test suites.
• Debug failing tests by stepping through execution line-by-line and examining intermediate results.
• Prototype and validate Robot Framework keywords and library calls before adding them to test files.
• Quickly test Selenium or other library operations in an interactive shell without writing full test cases.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides an interactive debug shell and library keywords for Robot Framework test execution, enabling step-through debugging and REPL-style keyword exploration during test development.

Yes, if you actively develop Robot Framework tests and value interactive debugging during development. The low install friction and permissive license make it a safe addition. However, the dormant maintenance status (945+ days since last release) means it is not receiving active updates; verify compatibility with your current Robot Framework and Python versions before relying on it for new projects. Suitable for established workflows; less ideal if you need ongoing support or compatibility updates.

Install

robotframework-debuglibrary on PyPI

pip install robotframework-debuglibrary

uv add robotframework-debuglibrary

poetry add robotframework-debuglibrary

Installing robotframework-debuglibrary

Before you install

Low install friction with a pure-Python wheel. Maintenance is dormant—last release was over 945 days ago—but the package remains stable and archived repository shows no active development. Suitable for established workflows that don't require ongoing updates.

License in practice

Licensed under New BSD (permissive), allowing free use, modification, and distribution with minimal restrictions. No licensing barrier to adoption.

Quickstart

pip install robotframework-debuglibrary

# In a Robot Framework test file:
*** Settings ***
Library    DebugLibrary

*** Test Cases ***
Example
    Debug
    # or run standalone:
    # $ rfdebug

Requires Robot Framework and prompt-toolkit as runtime dependencies; Python 3.8 or later (version 2.0+).

Verify before relying

• Whether step debugging works correctly with all Robot Framework versions currently in use.
• Compatibility with recent versions of prompt-toolkit and Robot Framework given dormant maintenance status.
• Whether the rfdebug shell history file location works reliably on all operating systems.

Package facts

Evidence: robotframework_debuglibrary-2.5.0-py3-none-any.whl

Keywords: robotframework, debug, shell, repl

Tags

More Utilities packages