Repository files navigation

Content management extensions for Jupyter / IPython Notebook.

The content management extensions provide the following:

• Search dialog on dashboard, editor, and notebook screens to search over filenames and.ipynb content in the notebook directory
• IPython kernel extension to make Python notebooks reusable as modules and cookbooks (see thecookbooks tutorial)
• Full-page drag-and-drop upload target
• Pop-over table of contents navigation for notebooks

• Jupyter Notebook >=4.2 running on Python 3.x or Python 2.7.x
• Edge, Chrome, Firefox, or Safari

The following steps install the extension package usingpip and enable theextension in the active Python environment.

pip install jupyter_cmsjupyter cms quick-setup --sys-prefix

Runjupyter cms quick-setup --help for other options. Note that thesecond command is a shortcut for the following:

jupyter serverextensionenable --py jupyter_cms --sys-prefixjupyter nbextension install --py jupyter_cms --sys-prefixjupyter nbextensionenable --py jupyter_cms --sys-prefix

Alternatively, the following command both installs and enables the packageusingconda.

conda install jupyter_cms -c conda-forge

In either case, you will need to restart your notebook server if it was runningduring the enable/activate step.

The following steps deactivate the extension in the active Python environmentand uninstall the package usingpip.

jupyter cms quick-remove --sys-prefixpip uninstall jupyter_cms

Note that the first command is a shortcut for the following:

jupyter nbextension disable --py jupyter_cms --sys-prefixjupyter nbextension uninstall --py jupyter_cms --sys-prefixjupyter serverextension disable --py jupyter_cms --sys-prefix

The following command deactivates and uninstalls the package if it wasinstalled usingconda.

conda remove jupyter_cms

This extension used to supportbundlers. That functionality has graduated andis available in Jupyter Notebook >=5.0. SeeCustom bundlerextensionsin the documentation for more information.

If you cannot upgrade to notebook>=5.0 and need bundler support, install a version ofthis extension prior to 0.7.0.

This repository is setup for a conda-based development environment. Theseinstructions assume that have you installedconda.

# clone this repo if you don't have itgit clone https://github.com/jupyter-incubator/contentmanagement.gitcd contentmanagement# create a `cms` conda environmentmake env# run unit testsmake test# run a notebook server with the extension installedmake notebook# build a source packagemake sdist# release the source package on pypimake release# remove built artifactsmake clean# remove build artifacts and cms environmentmake nuke

• Importing notebooks as modules does work with ipyparallel, but not with itssync_imports context manager. See thesolution and explanation in issue #32.