1<page xmlns="http://projectmallard.org/1.0/" type="topic" id="ipython_plugin"> 2 <info> 3 <link type="guide" xref="index#advanced" /> 4 <title type="sort">2. IPython Plugin</title> 5 <link type="next" xref="howto_write_a_plugin" /> 6 <desc> 7 When all else fails 8 </desc> 9 <credit type="author"> 10 <name>Eitan Isaacson</name> 11 <email>eitan@ascender.com</email> 12 </credit> 13 <credit type="author"> 14 <name>Peter Parente</name> 15 <email>pparent@us.ibm.com</email> 16 </credit> 17 <credit type="author"> 18 <name>Aline Bessa</name> 19 <email>alibezz@gmail.com</email> 20 </credit> 21 <license> 22 <p>Creative Commons Share Alike 3.0</p> 23 </license> 24 </info> 25 <title> IPython Console Plugin</title> 26 <p> 27 The IPython Console Plugin allows real-time interaction with a selected item in the <link xref="desktop_tree_view"> 28 Application Tree View</link>. Since the IPython Console Plugin is an interactive Python shell, you can import any Python 29 modules you want. 30 </p> 31 32 <note style="tip"> 33 <p> 34 Make sure you have the standalone package IPython installed in your system. Otherwise, the IPython Console Plugin will 35 not work properly. 36 </p> 37 </note> 38 39 <section id="running_ipython_plugin"> 40 <title>Running the IPython Console Plugin</title> 41 <p> 42 To run the IPython Console Plugin, select one of the accessible items 43 listed in the Application Tree View - either an application or a widget. In the plugin, the 44 selected item will correspond to the variable 'acc'. 45 </p> 46 <p> 47 Pressing <key>Tab</key> shows completions for the current command in the console, 48 what can be useful for discovering pyatspi methods. 49 </p> 50 51 <figure> 52 <title>Investigating selected items with the IPython Console Plugin</title> 53 <desc> 54 The IPython Console Plugin lets you investigate methods, constants, and properties 55 related to a selected item in the Application Tree View. 56 </desc> 57 <media type="image" mime="image/png" width="800" height="500" src="figures/IPython_plugin.png"> 58 <p> 59 The IPython Console Plugin lets you investigate methods, constants, and properties 60 related to a selected item in the Application Tree View. 61 </p> 62 </media> 63 </figure> 64 65 <note style="tip"> 66 <p> 67 Typing <cmd>help(acc)</cmd> in the IPython Console Plugin shows some useful documentation 68 about the corresponding selected accessible item. 69 </p> 70 </note> 71 </section> 72</page> 73