##// END OF EJS Templates
add chapter about extensions
Ville M. Vainio -
Show More
@@ -5113,6 +5113,60 b' the IPython team and request that the functionality be exposed in a'
5113 future version of IPython. Things not in ipapi are more likely to
5113 future version of IPython. Things not in ipapi are more likely to
5114 change over time.
5114 change over time.
5115
5115
5116 Provided extensions
5117 ===================
5118
5119 You can see the list of available extensions (and profiles) by doing
5120 ``import ipy_<TAB>``. Some extensions don't have the ``ipy_`` prefix in
5121 module name, so you may need to see the contents of IPython/Extensions
5122 folder to see what's available.
5123
5124 You can see a brief documentation of an extension by looking at the
5125 module docstring::
5126
5127 [c:p/ipython_main]|190> import ipy_fsops
5128 [c:p/ipython_main]|191> ipy_fsops?
5129
5130 ...
5131
5132 Docstring:
5133 File system operations
5134
5135 Contains: Simple variants of normal unix shell commands (icp, imv, irm,
5136 imkdir, igrep).
5137
5138 You can also install your own extensions - the recommended way is to
5139 just copy the module to ~/.ipython. Extensions are typically enabled
5140 by just importing them (e.g. in ipy_user_conf.py), but some extensions
5141 require additional steps, for example::
5142
5143 [c:p]|192> import ipy_traits_completer
5144 [c:p]|193> ipy_traits_completer.activate()
5145
5146 Note that extensions, even if provided in the stock IPython
5147 installation, are not guaranteed to have the same requirements as the
5148 rest of IPython - an extension may require external libraries or a
5149 newer version of Python than what IPython officially requires. An
5150 extension may also be under a more restrictive license than IPython
5151 (e.g. ipy_bzr is under GPL).
5152
5153 Just for reference, the list of bundled extensions at the time of
5154 writing is below:
5155
5156 astyle.py clearcmd.py envpersist.py ext_rescapture.py ibrowse.py
5157 igrid.py InterpreterExec.py InterpreterPasteInput.py ipipe.py
5158 ipy_app_completers.py ipy_autoreload.py ipy_bzr.py ipy_completers.py
5159 ipy_constants.py ipy_defaults.py ipy_editors.py ipy_exportdb.py
5160 ipy_extutil.py ipy_fsops.py ipy_gnuglobal.py ipy_kitcfg.py
5161 ipy_legacy.py ipy_leo.py ipy_p4.py ipy_profile_doctest.py
5162 ipy_profile_none.py ipy_profile_scipy.py ipy_profile_sh.py
5163 ipy_profile_zope.py ipy_pydb.py ipy_rehashdir.py ipy_render.py
5164 ipy_server.py ipy_signals.py ipy_stock_completers.py
5165 ipy_system_conf.py ipy_traits_completer.py ipy_vimserver.py
5166 ipy_which.py ipy_workdir.py jobctrl.py ledit.py numeric_formats.py
5167 PhysicalQInput.py PhysicalQInteractive.py pickleshare.py
5168 pspersistence.py win32clip.py __init__.py
5169
5116 Reporting bugs
5170 Reporting bugs
5117 ==============
5171 ==============
5118
5172
General Comments 0
You need to be logged in to leave comments. Login now