User plugins

User Plugins

NOTE: These informations apply to Spyder V3.2 onwards, and spyder V4.0beta1 !

For information about writing plugins see Writing Plugins

Spyder capabilities can be enhanced by installing plugins. There are currently two plugin types:

• UI plugins: These plugins add a new pane or a new menu action. Examples are Pylint, Profiler and Breakpoint plugins, which are shippêd with spyder by default.
• IO plugins: With these plugins Spyder can learn to load and save different file formats from the variable explorer

Some plugins are developed by core developers and can be found on github:

• spyder_line_profiler
• spyder_memory_profiler
• spyder_autopep8
• spyder_vim (in development)
• spyder_unittest
• spyder_notebook
• spyder_terminal
• spyder_reports
• spyder.terminado (in development)

We hope to see more plugins written by users in the future !

Install

Plugins are python packages with a name starting with spyder_. They are loaded from anywhere in sys.path or in ${HOME}/.spyder/plugins/. There are multiple ways to install a plugin:

• with pip and PyPi: pip install <PLUGIN.NAME> (note that pypi versions of core plugins are not up-to-date as of today)
• with pip without PyPi: Download and unzip (or clone) a plugin and run pip install . or python setup.py install from inside the plugin directory
• copy-paste: Download and unzip (or clone) a plugin and copy the directory starting with spyder_ in ${HOME}/.spyder/plugins/
• install last development version: pip install git+git://github.com/spyder-ide/<PLUGIN.NAME>.git

You have to restart spyder for the modifications to be taken into account (Menu File > Restart).

Uninstall

If the plugin was installed with pip, run pip uninstall <PLUGIN.NAME>. If the plugin was copy-pasted in ${HOME}/.spyder/plugins/, just remove its directory.