summaryrefslogtreecommitdiffstats
path: root/development/pudb/README
blob: 76e9ca02bddb6140e0109fea90432b55655eeb01 (plain)
PuDB is a full-screen, console-based visual debugger for Python.

Its goal is to provide all the niceties of modern GUI-based debuggers in a
more lightweight and keyboard-friendly package. PuDB allows you to debug
code right where you write and test it--in a terminal. If you've worked
with the excellent (but nowadays ancient) DOS-based Turbo Pascal or C
tools, PuDB's UI might look familiar.

By default this SlackBuild builds the python2 debugger, and if python3 is
detected, the python3 version too. The Pygments SlackBuild will automatically
install for python3 too.

NOTE: The python3 application is named pudb3.
NOTE: You need python3-urwid installed to use pudb3.

OPTIONS

To *ONLY* build the python2 version, use:

NO_PYTHON3=yes ./pudb.SlackBuild

To *ONLY* build the python3 version, use:

NO_PYTHON2=yes ./pudb.SlackBuild

The python2 version requires a newer version of urwid than the stock Slackware
one, therefore this also builds a custom urwid named py2_urwid, which it can
use. This should not conflict with the stock Slackware version.

OPTIONAL DEPENDENCIES

python3-urwid is a runtime for the python3 version. Note that it will still
build without this, so it can be installed later if needed.

###############################################################################

GETTING STARTED

Please see starting.rst usage.rst misc.rst and shells.rst in
/usr/doc/pudb-$VERSION to get started, and also -

Online docs:

https://documen.tician.de/pudb/

A simple, but useful, illustrated example page:

http://heather.cs.ucdavis.edu/~matloff/pudb.html

Github page:

https://github.com/inducer/pudb