To build and install the development version on Jupyter Notebook and JupyterLab 3: pip install. Install the development dependencies: pip install -r dev-requirements-jl3.txt This is because the JavaScript assets are compiled using JupyterLab's jlpm command. The main branch supports both JupyterLab 2 and 3 as well as Jupyter Notebook, but it must be built using JupyterLab 3. One server API call is made during initialisation to obtain the storage configuration.Įverything else is done client-side so should work even if the server is disconnected. This extension stores notebooks in browser storage using the IndexedDB API, wrapped with Dexie.js.
- A repository ID and path of the notebook within Jupyter Notebook are used, joined by a.
- Local-storage is limited by quotas imposed by the browser.
-
There are several major limitations including: This is used when storing and retrieving notebooks.ĭefault is the value of the BINDER_REPO_URL environment variable.Ī callable that returns the repository reference URL.ĭefault is the value of the BINDER_REF_URL environment variable.ĭefault is the values of the BINDER_LAUNCH_HOST andīINDER_PERSISTENT_REQUEST environment variables.Ī callable that returns the label used to link to the repository. This extension can be configured in jupyter_notebook_config.py by setting the following properties of c.OfflineNotebookConfig:Ī callable that returns the repository ID. If you don't see the buttons check the Javascript console log. See the configuration section below to enable the other buttons on other systems. If you are running this on mybinder all buttons should be visible. You should always see the Download button. Saving and loading uses the repository ID and the path of the current notebook. copy the permanent mybinder URL to share this repository.open the permanent URL of the repository containing this notebook.save the in-memory state of the notebook to local-storage.download the in-memory (browser) state of the notebook.You should see up to five new buttons depending on your configuration and where you are running the notebook: This is not needed on JupyterLab 3 due to the new extensions framework that means the JavaScript can be included in the Python pip package.
If you are using JupyterLab 2 you must manually install the JavaScript component of the extension: jupyter labextension install jupyter-offlinenotebook
This should automatically enable the extension on Jupyter Notebook and JupyterLab 3. Installation pip install jupyter-offlinenotebook Save and load notebooks to browser storage, even if you've lost your connection to the server.