From f5542eadc29038886c8fbf82670b18faca5eff75 2014-04-28 18:14:48 From: Thomas Kluyver Date: 2014-04-28 18:14:48 Subject: [PATCH] Describe using PyPI/pip to distribute & install extensions From discussion on gh-5742 --- diff --git a/docs/source/config/extensions/index.rst b/docs/source/config/extensions/index.rst index a869787..3ab4655 100644 --- a/docs/source/config/extensions/index.rst +++ b/docs/source/config/extensions/index.rst @@ -14,8 +14,14 @@ Getting extensions A few important extensions are :ref:`bundled with IPython `. Others can be found on the `extensions index -`_ on the wiki, and installed with -the ``%install_ext`` magic function. +`_ on the wiki, and +the `Framework :: IPython tag `_ +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 ================ @@ -72,7 +78,9 @@ within the :ref:`IPython directory `. This directory is added to :data:`sys.path` automatically. When your extension is ready for general use, please add it to the `extensions -index `_. +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: