Important

This documentation covers IPython versions 6.0 and higher. Beginning with version 6.0, IPython stopped supporting compatibility with Python versions lower than 3.3 including all versions of Python 2.7.

If you are looking for an IPython version compatible with Python 2.7, please use the IPython 5.x LTS release and refer to its documentation (LTS is the long term support release).

Configuration and customization

Configuring IPython

• Introduction to IPython configuration
  • Setting configurable options
  • Profiles
  • The IPython directory
  • Systemwide configuration
• IPython options
  • Terminal IPython options
  • IPython kernel options
• IPython shortcuts
• Specific config details
  • Custom Prompts
  • Terminal Colors
  • Editor configuration
  • Keyboard Shortcuts

See also

Overview of the IPython configuration system

Technical details of the config system.

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
• Accessing user namespace and local scope
• Silencing the magic output
• Complete Example
• Mime Renderer Extensions
• Custom input transformation
  • String based transformations
  • AST transformations
• IPython Events
  • Events
• Integrating with GUI event loops
  • Integrating with a new event loop in the terminal
  • Integrating with a new event loop in the kernel