Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.85 KB

README.md

File metadata and controls

34 lines (21 loc) · 1.85 KB

IPython-extensions: more magic(s) for IPython

This package consists of various IPython extensions (mostly new %magics). It exists mainly to make installation of these extension easier: you only need to install and update one package to get multiple extensions. Also, the up-to-now used %install_ext magic is deprecated and will be removed in a future version, so the only way to distribute extensions is via python packages.

Installation

With pip:

pip install ipyext

With conda:

conda install -c https://conda.anaconda.org/janschulz ipyext

Documentation

The documentation can be found on http://ipython-extensions.readthedocs.org/en/latest/

Contributing

You have an IPython extension (e.g. a %magic command) but it's too small to build your own package? You are welcome to contribute it to this repository!

To prevent bit rot, it should follow the guidelines outlined in CONTRIBUTING.md, meaning:

  • it should be IPython centric (notebook centric extensions belong to the jupyter notebook extension repo)
  • it should have proper documentation (preferable in numpydoc style)
  • it should have a few tests of the functionality (see examples in this repository or in IPython)

Build Status Documentation Status