IPython
  • IPython Documentation
  • Overview
    • Enhanced interactive Python shell
      • Main features of the interactive shell
    • Decoupled two-process model
    • Interactive parallel computing
      • Portability and Python requirements
  • What’s new in IPython
    • 6.x Series
      • IPython 6.1
      • IPython 6.0
        • New completion API and Interface
        • Python 3 only codebase
        • Configurable TerminalInteractiveShell, readline interface
        • Misc improvements
        • Backward incompatible changes
    • Issues closed in the 6.x development cycle
      • Issues closed in 6.1
      • Issues closed in 6.0
    • 5.x Series
      • IPython 5.4
        • Configurable TerminalInteractiveShell
        • Define _repr_mimebundle_
        • Execution Heuristics
        • Implement Display IDs
        • Display function
        • Miscs
      • IPython 5.3
      • IPython 5.2.2
      • IPython 5.2.1
      • IPython 5.2
      • IPython 5.1
        • True Color feature
      • IPython 5.0
        • New terminal interface
        • Backwards incompatible changes
        • Provisional Changes
        • Deprecated Features
        • Known Issues:
    • Issues closed in the 5.x development cycle
      • Issues closed in 5.4
      • Issues closed in 5.3
      • Issues closed in 5.2
      • Issues closed in 5.1
      • Issues closed in 5.0
    • 4.x Series
      • IPython 4.2
      • IPython 4.1
      • IPython 4.0
    • Issues closed in the 4.x development cycle
      • Issues closed in 4.2
      • Issues closed in 4.1
      • Issues closed in 4.0
    • 3.x Series
      • IPython 3.2.3
      • IPython 3.2.2
      • IPython 3.2.1
      • IPython 3.2
      • IPython 3.1
      • Release 3.0
        • Using different kernels
        • Typing unicode identifiers
        • Widget migration guide
        • Other new features
        • Backwards incompatible changes
    • Issues closed in the 3.x development cycle
      • Issues closed in 3.2.1
      • Issues closed in 3.2
      • Issues closed in 3.1
      • Issues closed in 3.0
    • Migrating Widgets to IPython 3
      • Upgrading Notebooks
      • Upgrading Custom Widgets
        • Javascript
        • Python
      • Details
        • Asynchronous
        • Symmetry
        • Smaller Changes
      • Comm and Widget PR Index
    • 2.x Series
      • Release 2.4
      • Release 2.3.1
      • Release 2.3.0
      • Release 2.2.0
      • Release 2.1.0
      • Release 2.0.0
        • New stuff in the IPython notebook
        • Single codebase Python 3 support
        • Selecting matplotlib figure formats
        • clear_output changes
        • Extending configurable containers
        • Changes to hidden namespace on startup
        • Using dill to expand serialization support
        • New IPython console lexer
        • DisplayFormatter changes
        • Other changes
        • Backwards incompatible changes
    • Issues closed in the 2.x development cycle
      • Issues closed in 2.4.1
      • Issues closed in 2.3.1
      • Issues closed in 2.3.0
      • Issues closed in 2.2.0
      • Issues closed in 2.1.0
      • Issues closed in 2.0.0
    • 1.0 Series
      • Release 1.0.0: An Afternoon Hack
        • Reorganization
        • Public APIs
        • Core
        • NbConvert
        • Notebook
        • Kernel
        • Parallel
        • QtConsole
    • Issues closed in the 1.0 development cycle
      • Issues closed in 1.2
      • Issues closed in 1.1
      • Issues closed in 1.0
    • 0.13 Series
      • Release 0.13
        • Major Notebook improvements: new user interface and more
        • Other improvements to the Notebook
        • Cell magics
        • Tab completer improvements
        • Improvements to the Qt console
        • Parallel
        • Kernel/Engine unification
        • Official Public API
        • IPython notebook file icons
        • New top-level locate command
        • Other new features and improvements
        • Major Bugs fixed
        • Backwards incompatible changes
    • Issues closed in the 0.13 development cycle
      • Issues closed in 0.13
    • 0.12 Series
      • Release 0.12.1
      • Release 0.12
        • An interactive browser-based Notebook with rich media support
        • Two-process terminal console
        • Tabbed QtConsole
        • Full Python 3 compatibility
        • Standalone Kernel
        • PyPy support
    • Issues closed in the 0.12 development cycle
      • Issues closed in 0.12.1
      • Issues closed in 0.12
    • 0.11 Series
      • Release 0.11
        • Authors and support
        • Development summary: moving to Git and Github
        • Qt Console
        • High-level parallel computing with ZeroMQ
        • Refactoring
        • ZeroMQ architecture
        • Python 3 support
        • Unicode
        • Integration with Microsoft Visual Studio
        • Additional new features
        • Backwards incompatible changes
        • Known Regressions
        • Removed Features
        • Credits
    • Issues closed in the 0.11 development cycle
    • 0.10 series
      • Release 0.10.2
      • Release 0.10.1
      • Release 0.10
        • New features
        • Bug fixes
        • Backwards incompatible changes
    • 0.9 series
      • Release 0.9.1
      • Release 0.9
        • New features
        • Bug fixes
        • Backwards incompatible changes
        • Changes merged in from IPython1
    • 0.8 series
      • Release 0.8.4
      • Release 0.8.3
      • Release 0.8.2
      • Older releases
  • Installation
    • Installing IPython
      • Quick Install
      • Overview
        • Dependencies
        • Installing IPython itself
        • Installation using pip
        • Installation from source
        • Installing the development version
    • Installing the IPython kernel
      • Kernels for Python 2 and 3
      • Kernels for different environments
    • Quick install reminder
  • Tutorial
    • Introducing IPython
      • The four most helpful commands
      • Tab completion
      • Exploring your objects
      • Magic functions
        • Running and Editing
        • Debugging
      • History
      • System shell commands
        • Define your own system aliases
      • Configuration
        • Startup Files
    • Rich Outputs
    • Plotting
    • IPython reference
      • Command-line usage
        • Command-line Options
      • Interactive use
        • Caution for Windows users
        • Magic command system
        • Access to the standard Python help
        • Dynamic object information
        • Session logging and restoring
        • System shell access
        • Manual capture of command output and magic output
        • System command aliases
        • Recursive reload
        • Verbose and colored exception traceback printouts
        • Input caching system
        • Output caching system
        • Directory history
        • Automatic parentheses and quotes
      • IPython as your default Python environment
      • Embedding IPython
      • Using the Python debugger (pdb)
        • Running entire programs via pdb
        • Post-mortem debugging
      • Pasting of code starting with Python or IPython prompts
      • GUI event loop support
        • PyQt and PySide
      • Plotting with matplotlib
      • Interactive demos with IPython
    • IPython as a system shell
      • Overview
      • Environment variables
      • Aliases
      • Directory management
      • Prompt customization
      • String lists
        • Real world example: remove all files outside version control
        • The .s, .n, .p properties
    • IPython Tips & Tricks
      • Embed IPython in your programs
      • Run doctests
      • Use IPython to present interactive demos
      • Suppress output
      • Lightweight ‘version control’
    • Python vs IPython
      • Quick overview:
      • Accessing help
      • Shell Assignment
        • Magics
        • Combining it all
    • Built-in magic commands
      • Line magics
      • Cell magics
  • Configuration and customization
    • Configuring IPython
      • Introduction to IPython configuration
        • Setting configurable options
        • Profiles
        • The IPython directory
      • IPython options
        • Terminal IPython options
        • IPython kernel options
      • IPython shortcuts
        • Single Filtered shortcuts
        • Multi Filtered shortcuts
      • Specific config details
        • Custom Prompts
        • Terminal Colors
        • Editor configuration
        • Keyboard Shortcuts
    • Extending and integrating with IPython
      • IPython extensions
        • Getting extensions
        • Using extensions
        • Writing extensions
        • Extensions bundled with IPython
      • Integrating your objects with IPython
        • Tab completion
        • Rich display
        • Custom exception tracebacks
      • Defining custom magics
      • Custom input transformation
        • String based transformations
        • AST transformations
      • IPython Events
        • Events
      • Integrating with GUI event loops
        • Event loops in the terminal
        • Event loops in the kernel
  • Developer’s guide for third party tools and libraries
    • How IPython works
      • Terminal IPython
      • The IPython Kernel
    • Making simple Python wrapper kernels
      • Required steps
      • Example
      • Optional steps
    • Execution semantics in the IPython kernel
    • New IPython Console Lexer
    • Overview of the IPython configuration system
      • Configuration file location
        • Locating these files
      • Profiles
    • IPython GUI Support Notes
  • Guide for IPython core Developers
    • Backporting Pull requests
    • Backport with ghpro
  • IPython release process
    • 1. Set Environment variables
    • 2. Create GitHub stats and finish release note
    • 3. Make sure the repository is clean
    • 4. Update the release version number
    • 5. Run the tools/build_release script
    • 6. Create and push the new tag
    • 7. Run the release script
    • 8. Draft a short release announcement
    • 9. Update milestones on GitHub
    • 10. Update the IPython website
    • 11. Update readthedocs
    • 12. Update the Conda-Forge feedstock
    • 13. Celebrate!
      • Old Documentation
  • The IPython API
    • IPython
      • 3 Functions
    • Module: core.alias
      • 4 Classes
      • 1 Function
    • Module: core.application
      • 2 Classes
    • Module: core.autocall
      • 3 Classes
    • Module: core.builtin_trap
      • 1 Class
    • Module: core.compilerop
      • Authors
      • 1 Class
      • 2 Functions
    • Module: core.completer
      • Latex and Unicode completion
        • Forward latex/unicode completion
        • Backward latex completion
      • Experimental
      • 5 Classes
      • 13 Functions
    • Module: core.completerlib
      • 10 Functions
    • Module: core.crashhandler
      • 1 Class
      • 1 Function
    • Module: core.debugger
      • 2 Classes
      • 5 Functions
    • Module: core.error
      • 5 Classes
    • Module: core.events
      • 1 Class
      • 5 Functions
    • Module: core.excolors
      • 1 Class
      • 1 Function
    • Module: core.extensions
      • 1 Class
    • Module: core.formatters
      • 16 Classes
      • 2 Functions
    • Module: core.getipython
      • 1 Function
    • Module: core.history
      • 4 Classes
      • 3 Functions
    • Module: core.historyapp
      • 3 Classes
    • Module: core.hooks
      • 1 Class
      • 8 Functions
    • Module: core.inputsplitter
      • 4 Classes
      • 7 Functions
    • Module: core.inputtransformer
      • 5 Classes
      • 11 Functions
    • Module: core.interactiveshell
      • 6 Classes
      • 2 Functions
    • Module: core.logger
      • 1 Class
    • Module: core.macro
      • 1 Class
    • Module: core.magic
      • 4 Classes
      • 6 Functions
    • Module: core.magic_arguments
      • 8 Classes
      • 3 Functions
    • Module: core.oinspect
      • 1 Class
      • 10 Functions
    • Module: core.page
      • 10 Functions
    • Module: core.payload
      • 1 Class
    • Module: core.payloadpage
      • 2 Functions
    • Module: core.prefilter
      • 16 Classes
      • 1 Function
    • Module: core.profileapp
      • 4 Classes
      • 2 Functions
    • Module: core.profiledir
      • 2 Classes
    • Module: core.prompts
      • 1 Class
    • Module: core.pylabtools
      • 10 Functions
    • Module: core.shellapp
      • 1 Class
    • Module: core.splitinput
      • 1 Class
      • 1 Function
    • Module: core.ultratb
      • Color schemes
      • 7 Classes
      • 10 Functions
    • Module: display
      • 21 Classes
      • 16 Functions
    • Module: lib.backgroundjobs
      • 4 Classes
    • Module: lib.clipboard
      • 1 Class
      • 3 Functions
    • Module: lib.deepreload
      • 9 Functions
    • Module: lib.demo
      • Provided classes
      • Subclassing
      • Operation
      • 8 Classes
      • 2 Functions
    • Module: lib.editorhooks
      • 11 Functions
    • Module: lib.guisupport
      • 6 Functions
    • Module: lib.inputhook
      • 11 Classes
    • Module: lib.latextools
      • 1 Class
      • 6 Functions
    • Module: lib.lexers
      • 4 Classes
      • 1 Function
    • Module: lib.pretty
      • Example Usage
      • Extending
      • 7 Classes
      • 4 Functions
    • Module: lib.security
      • 2 Functions
    • Module: paths
      • 5 Functions
    • Module: terminal.debugger
      • 1 Class
      • 1 Function
    • Module: terminal.embed
      • 3 Classes
      • 1 Function
    • Module: terminal.interactiveshell
      • 1 Class
      • 1 Function
    • Module: terminal.ipapp
      • 3 Classes
      • 1 Function
    • Module: terminal.magics
      • 1 Class
      • 1 Function
    • Module: terminal.prompts
      • 3 Classes
    • Module: terminal.shortcuts
      • 12 Functions
    • Module: testing
      • 1 Function
    • Module: testing.decorators
      • 11 Functions
    • Module: testing.globalipapp
      • 1 Class
      • 3 Functions
    • Module: testing.iptest
      • 4 Classes
      • 5 Functions
    • Module: testing.iptestcontroller
      • 2 Classes
      • 7 Functions
    • Module: testing.ipunittest
      • Authors
      • 2 Classes
      • 2 Functions
    • Module: testing.skipdoctest
      • 1 Function
    • Module: testing.tools
      • Authors
      • 3 Classes
      • 13 Functions
    • Module: utils.PyColorize
      • 1 Class
    • Module: utils.capture
      • 3 Classes
    • Module: utils.colorable
      • 1 Class
    • Module: utils.coloransi
      • 5 Classes
      • 1 Function
    • Module: utils.contexts
      • 2 Classes
    • Module: utils.data
      • 3 Functions
    • Module: utils.decorators
      • 2 Functions
    • Module: utils.dir2
      • 3 Functions
    • Module: utils.encoding
      • 2 Functions
    • Module: utils.frame
      • 4 Functions
    • Module: utils.generics
      • 2 Functions
    • Module: utils.importstring
      • 1 Function
    • Module: utils.io
      • 1 Class
      • 6 Functions
    • Module: utils.ipstruct
      • 1 Class
    • Module: utils.module_paths
      • 3 Functions
    • Module: utils.openpy
      • 4 Functions
    • Module: utils.path
      • 1 Class
      • 16 Functions
    • Module: utils.process
      • 1 Class
      • 2 Functions
    • Module: utils.sentinel
      • 1 Class
    • Module: utils.shimmodule
      • 3 Classes
    • Module: utils.strdispatch
      • 1 Class
    • Module: utils.sysinfo
      • 5 Functions
    • Module: utils.syspathcontext
      • 2 Classes
    • Module: utils.tempdir
      • 2 Classes
    • Module: utils.terminal
      • 4 Functions
    • Module: utils.text
      • 5 Classes
      • 13 Functions
    • Module: utils.timing
      • 7 Functions
    • Module: utils.tokenize2
      • 4 Classes
      • 8 Functions
    • Module: utils.tokenutil
      • 3 Functions
    • Module: utils.tz
      • 1 Class
      • 1 Function
    • Module: utils.ulinecache
      • 1 Function
    • Module: utils.version
      • 1 Function
    • Module: utils.wildcard
      • Authors
      • 6 Functions
  • About IPython
    • History
      • Origins
    • Licenses and Copyright
      • Licenses
      • About the IPython Development Team
      • Our Copyright Policy
      • Miscellaneous
 
IPython
  • Docs »
  • Search

© Copyright The IPython Development Team. Last updated on Sep 12, 2017.

Built with Sphinx using a theme provided by Read the Docs.