Skip to content

README.rst

Latest commit

 

History

History
56 lines (40 loc) · 1.7 KB

README.rst

File metadata and controls

56 lines (40 loc) · 1.7 KB

About

A simple IPython extension to show the path and virtualenv in the prompt. The extension attempts to detect both venv and Anaconda environments, and shows it along with the path above the standard IPython input prompt.

Installation

Install as usual from PyPI:

pip install ipython-venv-path-prompt

or from git:

git clone https://github.com/javidcf/ipython_venv_path_prompt.git
cd ipython_venv_path_prompt/
python setup.py install

The extension can be loaded from within an IPython session with %load_ext ipython_venv_path_prompt. To load the extension automatically, edit your IPython profile file. This file is located under your profile directory, which by default is ~/.ipython/profile_default, but you can check the exact location with the following command:

ipython -c "import IPython; print(IPython.get_ipython().profile_dir.location)"

If there is no ipython_config.py file in that directory, create one. Then, edit the file and add the extension name to the list of extensions to load on startup. Your configuration file could look like this:

try:
    # Load the extension only if the package is installed
    import ipython_venv_path_prompt
    c = get_config()
    c.InteractiveShellApp.extensions = [
        'ipython_venv_path_prompt'
    ]
except ImportError: pass

For more information about IPython configuration, see Introduction to IPython documentation.