tuskar/doc/source/debugging-with-ipython.rst
Jay Dobies e305f61b18 Fix tuskar docs building
Fixed a problem with the docs not even building and cleaned up the
sphinx warnings. Changed the directory structure to more closely
resemble other OpenStack projects. This doesn't address any of the
content yet, simply the structure and ability to build.

Change-Id: I2b00b12b7664d58d44994b9d0e23a55c96379c18
2014-02-18 13:50:14 -05:00

36 lines
821 B
ReStructuredText

======================
Debugging with iPython
======================
Requirements
------------
::
$ yum install python-ipython
$ cd tuskar
$ find . | grep no-global-site-packages.txt | xargs rm
The 'find' will allow you to import 'global' packages in Tox.
Debugging
---------
Place these two lines in the place you want to debug/drop to shell:
::
import IPython
IPython.embed()
Then start Tuskar as usual and do a GET/POST/etc. Once the code
execution hits these two lines, you will be dropped into the iPython shell
and you will have access to all local variables and the env defined in the
context of where you placed that two lines.
Tweaks
------
`ipythonrc <https://github.com/queezythegreat/settings/tree/master/ipython>`_
-> Colors on console, tab completion for methods and more ;-)