Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lebedov/ripdb

Remotely accessible IPython-enabled debugger
https://github.com/lebedov/ripdb

debugging-tool ipython python remote

Last synced: 3 days ago
JSON representation

Remotely accessible IPython-enabled debugger

Awesome Lists containing this project

README

        

.. -*- rst -*-

Remotely Accessible IPython-Enabled Debugger
============================================

Package Description
-------------------
ripdb is a wrapper around the IPython debugger that enables one to connect to
and control the debugger remotely via a socket handler. It combines
the functionality of `ipdb `_ and `rpdb
`_ in a single package.

.. image:: https://img.shields.io/pypi/v/ripdb.svg
:target: https://pypi.python.org/pypi/ripdb
:alt: Latest Version

Usage
-----
After installation, include the following in your code: ::

import ripdb
ripdb.set_trace()

This will start the debugger on port 4444 by default; to use a different port
instantiate the debugger as follows: ::

import ripdb
ripdb.set_trace(port=12345)

Connect to the debugger using telnet, netcat, or socat. If you want to enable
line completion and editing, you need to disable several terminal features
before connecting: ::

SAVED_STTY=`stty -g`; stty -icanon -opost -echo -echoe -echok -echoctl
-echoke; nc 127.0.0.1 4444; stty $SAVED_STTY

Development
-----------
The latest release of the package may be obtained from
`GitHub `_.

Authors
-------
See the included `AUTHORS
`_ file for more
information.

License
-------
This software is licensed under the `BSD License
`_. See the included
`LICENSE `_ file for
more information.