gamzinav/pudb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README to mention pudb script

Browse Source
This commit is contained in:
Aaron Meurer 2013-03-05 20:41:00 -07:00
parent 4059aeb09f
commit 42b8fe1ad6
1 changed files with 25 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.rst
View File

@ -1,9 +1,9 @@
PuDB is a full-screen, console-based visual debugger for Python.
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
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.
Here's a screenshot:
@ -15,26 +15,26 @@ You may watch a `screencast <http://vimeo.com/5255125>`_, too.
Features
--------
* Syntax-highlighted source, the stack, breakpoints and variables are all
visible at once and continuously updated. This helps you be more aware of
what's going on in your program. Variable displays can be expanded, collapsed
* Syntax-highlighted source, the stack, breakpoints and variables are all
visible at once and continuously updated. This helps you be more aware of
what's going on in your program. Variable displays can be expanded, collapsed
and have various customization options.
* Simple, keyboard-based navigation using single keystrokes makes debugging
quick and easy. PuDB understands cursor-keys and Vi shortcuts for navigation.
* Simple, keyboard-based navigation using single keystrokes makes debugging
quick and easy. PuDB understands cursor-keys and Vi shortcuts for navigation.
Other keys are inspired by the corresponding pdb coomands.
* Use search to find relevant source code, or use "m" to invoke the module
browser that shows loaded modules, lets you load new ones and reload existing
* Use search to find relevant source code, or use "m" to invoke the module
browser that shows loaded modules, lets you load new ones and reload existing
ones.
* Breakpoints can be set just by pointing at a source line and hitting "b" and
then edited visually in the breakpoints window. Or hit "t" to run to the line
* Breakpoints can be set just by pointing at a source line and hitting "b" and
then edited visually in the breakpoints window. Or hit "t" to run to the line
under the cursor.
* Drop to a Python shell in the current environment by pressing "!".
* PuDB places special emphasis on exception handling. A post-mortem mode makes
* PuDB places special emphasis on exception handling. A post-mortem mode makes
it easy to retrace a crashing program's last steps.
* IPython integration (see `wiki <http://wiki.tiker.net/PuDB>`_)
@ -59,11 +59,18 @@ To start debugging, simply insert::
into the piece of code you want to debug, or run the entire script with::
pudb my-script.py
or, in Python 3::
pudb3 my-script.py
This is equivalent to::
python -m pudb.run my-script.py
In Python 2.6 and higher, you can save four keystrokes and type::
python -m pudb my-script.py
which is useful if you want to run PuDB in a version of Python other than the
one you most recently installed PuDB with.
Documentation and Support
-------------------------