This extension is composed of a Python package named
for the server extension and a NPM package named
for the frontend extension.
- JupyterLab >= 2.0
Note: You will need NodeJS to install the extension.
pip install jupyterlab_publishfn jupyter lab build
If you are seeing the frontend extension but it is not working, check that the server extension is enabled:
jupyter serverextension list
If the server extension is installed and enabled but you are not seeing the frontend, check the frontend is installed:
jupyter labextension list
If it is installed, try:
jupyter lab clean jupyter lab build
jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
npm in lieu of
# Clone the repo to your local environment # Move to jupyterlab-publishfn directory # Install server extension pip install -e . # Register server extension jupyter serverextension enable --py jupyterlab_publishfn --sys-prefix # Install dependencies jlpm # Build Typescript source jlpm build # Link your development version of the extension with JupyterLab jupyter labextension install . # Rebuild Typescript source after making changes jlpm build # Rebuild JupyterLab after making any changes jupyter lab build
You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
# Watch the source directory in another terminal tab jlpm watch # Run jupyterlab in watch mode in one terminal tab jupyter lab --watch
Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).
pip uninstall jupyterlab_publishfn jupyter labextension uninstall jupyterlab-publishfn