Official repository for Spyder - The Scientific PYthon Development EnviRonment
Python JavaScript CSS HTML Shell Batchfile Other
Latest commit 79fe9cb May 23, 2017 @ccordoba12 ccordoba12 committed on GitHub Merge pull request #4506 from ghisvail/docs/manpage
PR: Add manpage for Spyder
Permalink
Failed to load latest commit information.
.github Adds Qt and PyQt version in the issue report. Feb 10, 2017
conda.recipe Change pep8 for pycodestyle in installation recipes. Mar 7, 2017
continuous_integration Testing: Simplify Circle testing and move coveralls to Travis May 22, 2017
doc Merge pull request #4506 from ghisvail/docs/manpage May 23, 2017
img_src Splash screen: png-->svg + v2-->v3 Jan 10, 2016
requirements Change pep8 to pycodestyle in requirements Apr 13, 2017
rope_profiling Move spyderlib/rope_patch.py to spyder Jul 4, 2016
scripts Add AppStream metainfo file Feb 8, 2017
spyder Merge from 3.x: PR #4511 May 23, 2017
spyder_breakpoints Merge after releasing 3.1.4 Apr 24, 2017
spyder_io_dcm Rename io plugins Jun 10, 2016
spyder_io_hdf5 Change copyright to the "Spyder Project Contributors" Aug 22, 2016
spyder_profiler Merge after releasing 3.1.4 Apr 24, 2017
spyder_pylint Merge after releasing 3.1.4 Apr 24, 2017
.checkignore Add quantifiedcode .checkignore for tests May 24, 2016
.ciocheck Style fixes reported by ciocheck Dec 17, 2016
.ciocopyright Add ciocheck config Oct 26, 2016
.coveragerc Testing: Omit other files from coverage Mar 13, 2017
.gitignore Removed .venv from .gitignore. May 12, 2017
.project Branch v2.1 is now the default repository Jun 22, 2011
.travis.yml Testing: Simplify Circle testing and move coveralls to Travis May 22, 2017
AUTHORS Change copyright to the "Spyder Project Contributors" Aug 22, 2016
Announcements.md Update announcements Apr 24, 2017
CHANGELOG.md Update Changelog Apr 24, 2017
CONTRIBUTING.md Contributing: Add a note about restarting Spyder after every change Apr 13, 2017
LICENSE Change copyright to the "Spyder Project Contributors" Aug 22, 2016
MANIFEST.in Merge from 3.1.x: PR #4353 Apr 11, 2017
README.md Fix Readme text Apr 13, 2017
RELEASE.md Improve some formatting in announcements Feb 20, 2017
appveyor.yml Testing: Restore Python 3.6 tests in AppVeyor and add Python 3.5 as well May 23, 2017
bootstrap.py Remove last references to spyderlib and fix copyrights Jul 4, 2016
circle.yml Testing: Simplify Circle testing and move coveralls to Travis May 22, 2017
create_app.py Change pep8 for pycodestyle in installation recipes. Mar 7, 2017
create_exe.py Change copyright to the "Spyder Project Contributors" Aug 22, 2016
gettext_compile.py Change copyright to the "Spyder Project Contributors" Aug 22, 2016
gettext_helpers.py gettext_helpers: Fix compilation of po files Aug 22, 2016
gettext_scan.py Change copyright to the "Spyder Project Contributors" Aug 22, 2016
png-convert-and-optimize.sh Backport PR #2216: Make all our png's compatible with libpng 1.6.2+ Jun 15, 2015
runtests.py Testing: Move PyQt4 tests to Travis Apr 9, 2017
setup.py Merge from 3.1.x: PR #4353 Apr 11, 2017

README.md

Spyder - The Scientific PYthon Development EnviRonment

Copyright © Spyder Project Contributors.

Project details

license pypi version Join the chat at https://gitter.im/spyder-ide/public

Build status

Travis status AppVeyor status CircleCI Coverage Status

Overview

screenshot

Spyder is a Python development environment with a lot of features:

  • Editor

    Multi-language editor with function/class browser, code analysis features (pyflakes and pylint are currently supported), code completion, horizontal and vertical splitting, and goto definition.

  • Interactive console

    Python or IPython consoles with workspace and debugging support to instantly evaluate the code written in the Editor. It also comes with Matplotlib figures integration.

  • Documentation viewer

    Show documentation for any class or function call made either in the Editor or a Console.

  • Variable explorer

    Explore variables created during the execution of a file. Editing them is also possible with several GUI based editors, like a dictionary and Numpy array ones.

  • Find in files

    Supporting regular expressions and mercurial repositories

  • File explorer

  • History log

Spyder may also be used as a PyQt5/PyQt4 extension library (module spyder). For example, the Python interactive shell widget used in Spyder may be embedded in your own PyQt5/PyQt4 application.

Documentation

You can read the Spyder documentation at:

http://pythonhosted.org/spyder/

Installation

This section explains how to install the latest stable release of Spyder. If you prefer testing the development version, please use the bootstrap script (see next section).

The easiest way to install Spyder is:

On Windows:

Using one (and only one) of these scientific Python distributions:

  1. Anaconda
  2. WinPython
  3. Python(x,y)

On Mac OSX:

On GNU/Linux

  • Through your distribution package manager (i.e. apt-get, yum, etc).
  • Using the Anaconda Distribution.
  • Installing from source (see below).

Cross-platform way from source

You can also install Spyder with the pip package manager, which comes by default with most Python installations. For that you need to use the command:

pip install spyder

To upgrade Spyder to its latest version, if it was installed before, you need to run

pip install --upgrade spyder

For more details on supported platforms, please refer to our installation instructions.

Important note: This does not install the graphical Python libraries (i.e. PyQt5 or PyQt4) that Spyder depends on. Those have to be installed separately after installing Python.

Running from source

The fastest way to run Spyder is to get the source code using git, install PyQt5 or PyQt4, and run these commands:

  1. Install our runtime dependencies (see below).
  2. cd /your/spyder/git-clone
  3. python bootstrap.py

You may want to do this for fixing bugs in Spyder, adding new features, learning how Spyder works or just getting a taste of it.

Dependencies

Important note: Most if not all the dependencies listed below come with Anaconda, WinPython and Python(x,y), so you don't need to install them separately when installing one of these Scientific Python distributions.

Build dependencies

When installing Spyder from its source package, the only requirement is to have a Python version greater than 2.7 (Python 3.2 is not supported anymore).

Runtime dependencies

  • Python 2.7 or 3.3+
  • PyQt5 5.2+ or PyQt4 4.6+: PyQt5 is recommended.
  • qtconsole 4.2.0+: Enhanced Python interpreter.
  • Rope and Jedi: Editor code completion, calltips and go-to-definition.
  • Pyflakes: Real-time code analysis.
  • Sphinx: Rich text mode for the Help pane.
  • Pygments 2.0+: Syntax highlighting for all file types it supports.
  • Pylint: Static code analysis.
  • Pycodestyle: Style analysis.
  • Psutil: CPU and memory usage on the status bar.
  • Nbconvert: Manipulation of notebooks in the Editor.
  • Qtawesome 0.4.1+: To have an icon theme based on FontAwesome.
  • Pickleshare: Show import completions on the Python consoles.
  • PyZMQ: Run introspection services asynchronously.
  • QtPy 1.1.0+: Abstracion layer for Python Qt bindings so that Spyder can run on PyQt4 and PyQt5.
  • Chardet: Character encoding auto-detection in Python.
  • Numpydoc: Used by Jedi to get return types for functions with Numpydoc docstrings.

Optional dependencies

  • Matplotlib: 2D/3D plotting in the Python and IPython consoles.
  • Pandas: View and edit DataFrames and Series in the Variable Explorer.
  • Numpy: View and edit two or three dimensional arrays in the Variable Explorer.
  • SymPy: Symbolic mathematics in the IPython console.
  • SciPy: Import Matlab workspace files in the Variable Explorer.
  • Cython: Run Cython files in the IPython console.

Contributing

Everyone is welcome to contribute. Please read our contributing instructions, then get started!

More information