https://github.com/javidcf/ipython_venv_path_prompt

A simple IPython extension to show the path and virtualenv in the prompt.
https://github.com/javidcf/ipython_venv_path_prompt

ipython ipython-console python virtualenv

Last synced: 9 days ago
JSON representation

A simple IPython extension to show the path and virtualenv in the prompt.

• Host: GitHub
• URL: https://github.com/javidcf/ipython_venv_path_prompt
• Owner: javidcf
• License: mit
• Created: 2020-02-14T12:12:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-07-21T11:11:54.000Z (over 3 years ago)
• Last Synced: 2024-10-13T03:41:47.070Z (23 days ago)
• Topics: ipython, ipython-console, python, virtualenv
• Language: Python
• Homepage:
• Size: 9.77 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
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:

.. code-block:: python

    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`_.

.. |venv| replace:: ``venv``

.. _venv: https://docs.python.org/3/library/venv.html

.. _Anaconda: https://www.anaconda.com/

.. _Introduction to IPython documentation: https://ipython.readthedocs.io/en/stable/config/intro.html