1
# Spyder - The Scientific PYthon Development EnviRonment
3
Copyright © 2009-2013 Pierre Raybaut.
4
Licensed under the terms of the MIT License
5
(see `spyderlib/__init__.py` for details)
10
Spyder is a Python development environment with tons of features:
14
Multi-language editor with function/class browser, code analysis
15
features (pyflakes and pylint are currently supported), code
16
completion, horizontal and vertical splitting, and goto definition.
20
Python or IPython consoles with workspace and debugging support to
21
instantly evaluate the code written in the Editor. It also comes
22
with Matplotlib figures integration.
24
* Documentation viewer
26
Show documentation for any class or function call made either in the
31
Explore variables created during the execution of a file. Editing
32
them is also possible with several GUI based editors, like a
33
dictionary and Numpy array ones.
35
* Find in files feature
37
Supporting regular expressions and mercurial repositories
39
* File/directories explorer
43
Spyder may also be used as a PyQt4/PySide extension library (module
44
`spyderlib`). For example, the Python interactive shell widget used in
45
Spyder may be embedded in your own PyQt4/PySide application.
50
This section explains how to install the latest stable release of
51
Spyder. If you prefer testing the development version, please use
52
the `bootstrap` script (see next section).
54
The easiest way to install Spyder is:
58
- Using one of our executable installers, which can be found
59
[here](http://spyderlib.googlecode.com/downloads).
60
- Or using one of these scientific Python distributions:
61
1. [Python(x,y)](http://pythonxy.googlecode.com)
62
2. [WinPython](http://code.google.com/p/winpython/)
63
3. [Anaconda](http://continuum.io/downloads)
67
- Using our DMG installer, which can be found
68
[here](http://spyderlib.googlecode.com/downloads).
69
- Using the [Anaconda Distribution](http://continuum.io/downloads).
70
- Through [MacPorts](http://www.macports.org/).
74
- Through your distribution package manager (i.e. `apt-get`, `yum`,
76
- Using the [Anaconda Distribution](http://continuum.io/downloads).
77
- Installing from source (see below).
79
### Installing from source
81
You can also install Spyder from its zip source package. For that you need to
82
download and uncompress the file called `spyder-x.y.z.zip`, which can be
83
found [here](http://spyderlib.googlecode.com/downloads). Then you need to
84
use the integrated `setup.py` script that comes with it and which is based
85
on the Python standard library `distutils` module, with the following command:
87
python setup.py install
89
Note that `distutils` does *not* uninstall previous versions of Python
90
packages: it simply copies files on top of an existing installation.
91
When using this command, it is thus highly recommended to uninstall
92
manually any previous version of Spyder by removing the associated
93
directories ('spyderlib' and 'spyderplugins') from your site-packages
96
From the [Python package index](http://pypi.python.org/pypi), you also
97
may install Spyder *and* upgrade an existing installation using `pip`
100
pip install --upgrade spyder
102
For more details on supported platforms, please go to
103
<http://pythonhosted.org/spyder/installation.html>.
108
*Imnportant note*: Most if not all the dependencies listed below come
109
with Python(x,y), WinPython and Anaconda, so you don't need to install
110
them separately when installing one of these scientific Python
113
### Build dependencies
115
When installing Spyder from its source package (using the command
116
`python setup.py install`), the only requirements is to have a Python version
119
### Runtime dependencies
123
* PyQt4 4.6+ or PySide 1.2.0+ (PyQt4 is recommended)
125
### Recommended modules
127
* Rope v0.9.2+ (editor code completion, calltips and go-to-definition)
129
* Pyflakes v0.5.0+ (real-time code analysis)
131
* Sphinx v0.6+ (object inspector's rich text mode)
133
* Numpy (N-dimensional arrays)
135
* Scipy (signal/image processing)
137
* Matplotlib (2D/3D plotting)
139
* IPython 0.13 (enhanced Python interpreter)
141
In Ubuntu you need to install `ipython-qtconsole`, on Fedora
142
`ipython-gui` and on Gentoo `ipython` with the `qt4` USE flag.
146
* Pygments (syntax highlighting for several file types).
148
* Pylint (static code analysis).
150
* Pep8 (style analysis).
153
## Running from source
155
It is possible to run Spyder directly (i.e. without installation)
156
from the unpacked zip folder (see *Installing from source*) using
157
Spyder's bootstrap script like this:
161
This is especially useful for beta-testing, troubleshooting
162
and development of Spyder itself.
165
## Build Windows installers
167
From the source package, you may build Windows installers to distribute
168
Spyder on all supported platforms and versions of Python.
170
Spyder has a single code base supporting both Python 2 and Python 3 but
171
the Windows installer will target a specific version of Python because
172
of the two external libraries included in the Windows installers
173
('pyflakes' and 'rope') which have specific versions for Python 2 and 3.
175
Moreover, despite the fact that Spyder code base supports all Python
176
architectures (32 and 64bit), the Windows installers will also target
177
specific architectures because of a limitation of the way `distutils`
178
works (see <http://bugs.python.org/issue6792>).
180
Example of Spyder binary installers for Windows:
182
* Python 2.7 and 32bit: spyder-2.3.0-win32-py2.7.exe
183
* Python 2.7 and 64bit: spyder-2.3.0-win-amd64-py2.7.exe
184
* Python 3.3 and 32bit: spyder-2.3.0-win32-py3.3.exe
185
* Python 3.3 and 64bit: spyder-2.3.0-win-amd64-py3.3.exe
190
* For code development please go to
192
<https://bitbucket.org/spyder-ide/spyderlib/>
194
* For bug reports and feature requests
196
<http://code.google.com/p/spyderlib/issues>
198
* For discussions and troubleshooting:
200
<http://groups.google.com/group/spyderlib>
added
removed
README.md
