gamzinav/pudb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
814 Commits 1 Branch 0 Tags 2.2 MiB
Python 100%
28759ddee0
Go to file
mjv761 28759ddee0 Add tags to .gitignore
2020-08-15 10:50:18 -06:00
.github/workflows Drop Py2 from CIs 2020-06-23 00:11:00 -05:00
doc Document the how to set new breakpoint() builtin in Python 3.7 2019-06-21 14:31:52 -06:00
manual-tests Convert tests to pytest 2016-03-31 09:15:31 -05:00
pudb Merge pull request #390 from eliasdorneles/add-run-as-module 2020-06-24 10:33:46 -05:00
test Placate flake8 3.8 2020-05-15 07:54:57 -05:00
.coveragerc Added TravisCI and codecove.io support 2017-04-06 18:52:23 +03:00
.editorconfig Add .editorconfig 2020-06-23 00:09:02 -05:00
.gitignore Add tags to .gitignore 2020-08-15 10:50:18 -06:00
.gitlab-ci.yml Drop Py2 from CIs 2020-06-23 00:11:00 -05:00
.mailmap Add .mailmap 2013-03-11 19:14:57 -06:00
debug_me.py Fix import cycle (Closes #325 on github) 2019-01-23 09:30:11 -06:00
example-shell.py Note in example-shell.py that returning returns control to the debugger 2017-04-17 14:09:12 -04:00
example-stringifier.py Fix simple typo: varialbes, -> variables, 2019-12-10 20:52:32 +11:00
example-theme.py Add note to example-theme.py about curses and raw modes 2013-12-05 20:48:07 -07:00
LICENSE Create docs, trim README (Fixes #239 on Github) 2017-04-05 17:01:16 -05:00
MANIFEST.in Add separate license file (requested by Dhiru Kolia) 2013-09-06 13:33:24 -05:00
README.rst Update README.rst 2020-08-13 13:23:03 -05:00
requirements.dev.txt Let pytest versions float to match CI scripts 2020-07-17 13:11:02 -05:00
setup.cfg wheel: disable universal flag 2015-11-12 22:00:19 +09:00
setup.py Drop Py2 from Trove 2020-06-23 00:09:56 -05:00
try-the-debugger.sh Minor fix to bfroehle's Python 3 changes. 2012-07-14 16:29:32 -04:00
upload_coverage.sh Fix coverage uploader script 2019-09-09 15:23:32 -05:00

README.rst 

PuDB: a console-based visual debugger for Python
================================================

.. image:: https://gitlab.tiker.net/inducer/pudb/badges/master/pipeline.svg
    :alt: Gitlab Build Status
    :target: https://gitlab.tiker.net/inducer/pudb/commits/master
.. image:: https://github.com/inducer/pudb/workflows/CI/badge.svg?branch=master&event=push
    :alt: Github Build Status
    :target: https://github.com/inducer/pudb/actions?query=branch%3Amaster+workflow%3ACI+event%3Apush
.. image:: https://badge.fury.io/py/pudb.png
    :alt: Python Package Index Release Page
    :target: https://pypi.org/project/pudb/

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:

.. image:: https://tiker.net/pub/pudb-screenshot.png

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
  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.
  Other keys are inspired by the corresponding pdb commands.

* 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
  under the cursor.

* Drop to a Python shell in the current environment by pressing "!".
  Or open a command prompt alongside the source-code via "Ctrl-X".

* PuDB places special emphasis on exception handling. A post-mortem mode makes
  it easy to retrace a crashing program's last steps.

* Ability to control the debugger from a separate terminal.

* IPython integration (see `wiki <http://wiki.tiker.net/PuDB>`_)

* Should work with Python 3.6 and newer. (Versions 2019.2 and older continue
  to support Python 2.7.)

Links
-----

`PuDB documentation <https://documen.tician.de/pudb>`_

PuDB also has a `mailing list <http://lists.tiker.net/listinfo/pudb>`_ that
you may use to submit patches and requests for help.  You can also send a pull
request to the `GitHub repository <https://github.com/inducer/pudb>`_

Development Version
-------------------

You may obtain the development version using the `Git <http://git-scm.org/>`_
version control tool.::

    git clone https://github.com/inducer/pudb.git

You may also `browse the code <https://github.com/inducer/pudb>`_ online.