Better project description.
This commit is contained in:
parent
377af946f4
commit
9d899ed818
67
setup.py
67
setup.py
@ -9,29 +9,55 @@ from pudb import VERSION
|
||||
|
||||
setup(name='pudb',
|
||||
version=VERSION,
|
||||
description='Python Urwid debugger',
|
||||
description='A full-screen, console-based Python debugger',
|
||||
long_description="""
|
||||
PuDB is a visual debugger for Python. It runs in the same terminal
|
||||
where you run your code. Installing it is as easy as::
|
||||
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.
|
||||
|
||||
|
||||
easy_install pudb
|
||||
|
||||
Here's a screenshot:
|
||||
|
||||
.. image:: http://tiker.net/pub/pudb-screenshot.png
|
||||
|
||||
You may watch a `screencast <http://vimeo.com/5255125>`_, too.
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
Why would you want to use pudb?
|
||||
* 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.
|
||||
|
||||
* Easy to use!
|
||||
* Syntax Highlighting
|
||||
* Offers better situational awareness than CLI-based debuggers
|
||||
* Single keystroke for most commands
|
||||
* Self-documenting
|
||||
* Set breakpoints visually
|
||||
* Easy access to a Python shell
|
||||
* 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
|
||||
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 "!".
|
||||
|
||||
* PuDB places special emphasis on exception handling. A post-mortem mode makes
|
||||
it easy to retrace a crashing program's last steps.
|
||||
|
||||
Installing
|
||||
----------
|
||||
|
||||
Install PuDB using the command::
|
||||
|
||||
easy_install pudb
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
@ -44,8 +70,17 @@ setup(name='pudb',
|
||||
|
||||
python -m pudb.run my-script.py
|
||||
|
||||
Getting the Development Version
|
||||
-------------------------------
|
||||
License and Dependencies
|
||||
------------------------
|
||||
|
||||
PuDB is distributed under the MIT license. It relies on the following
|
||||
excellent pieces of software:
|
||||
|
||||
* Ian Ward's `urwid <http://excess.org/urwid>`_ console UI library
|
||||
* Georg Brandl's `pygments <http://pygments.org>`_ syntax highlighter
|
||||
|
||||
Development Version
|
||||
-------------------
|
||||
|
||||
You may obtain the development version using the `Git <http://git-scm.org/>`_
|
||||
version control tool.::
|
||||
@ -54,10 +89,6 @@ setup(name='pudb',
|
||||
|
||||
You may also `browse the code <http://git.tiker.net/pudb.git>`_ online.
|
||||
|
||||
PuDB relies on the following excellent pieces of software:
|
||||
|
||||
* Ian Ward's `urwid <http://excess.org/urwid>`_ console UI library
|
||||
* Georg Brandl's `pygments <http://pygments.org>`_ syntax highlighter
|
||||
""",
|
||||
author='Andreas Kloeckner',
|
||||
author_email='inform@tiker.net',
|
||||
|
Loading…
Reference in New Issue
Block a user