Introduction to IPython configuration
Setting configurable options
Many of IPython's classes have configurable attributes. These can be configured in several ways.
Python config files
To create the blank config files, run:
ipython profile create [profilename]
If you leave out the profile name, the files will be created for the default profile (see :ref:`profiles`). These will typically be located in :file:`~/.ipython/profile_default/`, and will be named :file:`ipython_config.py`, :file:`ipython_notebook_config.py`, etc. The settings in :file:`ipython_config.py` apply to all IPython commands.
The files typically start by getting the root config object:
c = get_config()
You can then configure class attributes like this:
c.InteractiveShell.automagic = False
Be careful with spelling--incorrect names will simply be ignored, with no error.
To add to a collection which may have already been defined elsewhere, you can use methods like those found on lists, dicts and sets: append, extend, :meth:`~IPython.config.loader.LazyConfigValue.prepend` (like extend, but at the front), add and update (which works both for dicts and sets):
c.InteractiveShellApp.extensions.append('rmagic')
Command line arguments
Every configurable value can be set from the command line, using this syntax:
ipython --ClassName.attribute=value
Many frequently used options have short aliases and flags, such as --matplotlib (to integrate with a matplotlib GUI event loop) or --pdb (automatic post-mortem debugging of exceptions).
To see all of these abbreviated options, run:
ipython --help ipython notebook --help # etc.
The config magic
You can also modify config from inside IPython, using a magic command:
%config IPCompleter.greedy = True
At present, this only affects the current session - changes you make to config are not saved anywhere.
Profiles
IPython can use multiple profiles, with separate configuration and history. By default, if you don't specify a profile, IPython always runs in the default profile. To use a new profile:
ipython profile create foo # create the profile foo ipython --profile=foo # start IPython using the new profile
Profiles are typically stored in :ref:`ipythondir`, but you can also keep a profile in the current working directory, for example to distribute it with a project. To find a profile directory on the filesystem:
ipython locate profile foo
The IPython directory
IPython stores its files---config, command history and extensions---in the directory :file:`~/.ipython/` by default.