Skip to content

Commit

Permalink
Backport PR #5744: Describe using PyPI/pip to distribute & install ex…
Browse files Browse the repository at this point in the history
…tensions

From discussion on gh-5742
  • Loading branch information
takluyver committed May 7, 2014
1 parent b6ef160 commit 16c5ed4
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/source/config/extensions/index.rst
Expand Up @@ -14,8 +14,14 @@ Getting extensions

A few important extensions are :ref:`bundled with IPython <bundled_extensions>`.
Others can be found on the `extensions index
<https://github.com/ipython/ipython/wiki/Extensions-Index>`_ on the wiki, and installed with
the ``%install_ext`` magic function.
<https://github.com/ipython/ipython/wiki/Extensions-Index>`_ on the wiki, and
the `Framework :: IPython tag <https://pypi.python.org/pypi?:action=browse&c=586>`_
on PyPI.

Extensions on PyPI can be installed using ``pip``, like any other Python package.
Other simple extensions can be installed with the ``%install_ext`` magic. The
latter does no validation, so be careful using it on untrusted networks like
public wifi.

Using extensions
================
Expand Down Expand Up @@ -72,7 +78,9 @@ within the :ref:`IPython directory <ipythondir>`. This directory is
added to :data:`sys.path` automatically.

When your extension is ready for general use, please add it to the `extensions
index <https://github.com/ipython/ipython/wiki/Extensions-Index>`_.
index <https://github.com/ipython/ipython/wiki/Extensions-Index>`_. We also
encourage you to upload it to PyPI and use the ``Framework :: IPython``
classifier, so that users can install it with standard packaging tools.

.. _bundled_extensions:

Expand Down

0 comments on commit 16c5ed4

Please sign in to comment.