Content management extensions for Jupyter / IPython Notebook.
The content management extensions provide the following:
.ipynb
content in the notebook directoryThe following steps install the extension package using pip
and enable theextension in the active Python environment.
pip install jupyter_cms
jupyter cms quick-setup --sys-prefix
Run jupyter cms quick-setup --help
for other options. Note that thesecond command is a shortcut for the following:
jupyter serverextension enable --py jupyter_cms --sys-prefix
jupyter nbextension install --py jupyter_cms --sys-prefix
jupyter nbextension enable --py jupyter_cms --sys-prefix
Alternatively, the following command both installs and enables the packageusing conda
.
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 using pip
.
jupyter cms quick-remove --sys-prefix
pip uninstall jupyter_cms
Note that the first command is a shortcut for the following:
jupyter nbextension disable --py jupyter_cms --sys-prefix
jupyter nbextension uninstall --py jupyter_cms --sys-prefix
jupyter serverextension disable --py jupyter_cms --sys-prefix
The following command deactivates and uninstalls the package if it wasinstalled using conda
.
conda remove jupyter_cms
This extension used to support bundlers. That functionality has graduated andis available in Jupyter Notebook >=5.0. See Custom 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 installed conda
.
# clone this repo if you don't have it
git clone https://github.com/jupyter-incubator/contentmanagement.git
cd contentmanagement
# create a `cms` conda environment
make env
# run unit tests
make test
# run a notebook server with the extension installed
make notebook
# build a source package
make sdist
# release the source package on pypi
make release
# remove built artifacts
make clean
# remove build artifacts and cms environment
make nuke
sync_imports
context manager. See the solution and explanation in issue #32.