A sample Jupyter/IPython magic project.

Charles Reid b32e65359f update package name 3 months ago
data add data_files example 4 years ago
magic_octo_py updating package layout. 3 months ago
tests add docstrings 3 months ago
.gitignore have the tests we're including actually run and pass 2 years ago
.travis.yml Update tox and travis files 3 months ago
LICENSE.txt Add a LICENSE.txt file 2 years ago
MANIFEST.in Hopefully this will fix tox. 3 months ago
README.md update package name 3 months ago
setup.cfg "bdist_wheel" instead of "wheel" in setup.cfg 4 years ago
setup.py updating package layout. 3 months ago
tox.ini Update tox.ini 3 months ago


magic-octo-py: a simple Jupyter/IPython notebook extension

This simple project provides an example of how to create a package following the Python Packaging User Guide.

See the Tutorial on Packaging and Distributing Projects.

See the Distributing Extensions page of the documentation.

This notebook extension adds a "Download as tarball" file option to the notebook.

module contents

See the documentation for source of example.

Import the module from Jupyter notebook:

import magic_octo_py as mop


To build with Python 2:

python2 setup.py install

To build with Python 3:

python3 setup.py install

Optional: specify your python as needed - e.g., with conda in a Travis container, or on Homebrew, or etc.


To run the tests, you will need nose. From the project directory, run:


This will run all tests in the tests/ directory.

continuous integration (CI) with travis

The .travis.yml file runs the Travis tests by using the tox test automation library. tox sets up and configures tests for different python versions/compilations/system configurations on Travis.