Package: jupyter-offlinenotebook
Jupyter Offline NotebookSave and load notebooks to browser storage, even if you've lost your connection to the server.Installationpip install jupyter-offlinenotebookThis should automatically enable the extension on Jupyter Notebook and JupyterLab.This extension supports JupyterLab 3 and 4, and NBclassic.
Useversion 0.2.2for JupyterLab 2 and Notebook <7.UsageYou should see up to five new buttons depending on your configuration and where you are running the notebook:download the in-memory (browser) state of the notebooksave the in-memory state of the notebook to local-storageload a notebook from local-storageopen the permanent URL of the repository containing this notebookcopy the permanent mybinder URL to share this repositorySaving and loading uses the repository ID and the path of the current notebook.You should always see theDownloadbutton.
If you are running this on mybinder all buttons should be visible.
See the configuration section below to enable the other buttons on other systems.If you don't see the buttons check the Javascript console log.Seeexample.ipynbConfigurationThis extension can be configured injupyter_notebook_config.pyby setting the following properties ofc.OfflineNotebookConfig:repository_id:
A callable that returns the repository ID.
This is used when storing and retrieving notebooks.
Default is the value of theBINDER_REPO_URLenvironment variable.repository_ref_url:
A callable that returns the repository reference URL.
Default is the value of theBINDER_REF_URLenvironment variable.binder_persistent_url:
A callable that returns the repository reference URL.
Default is the values of theBINDER_LAUNCH_HOSTandBINDER_PERSISTENT_REQUESTenvironment variables.binder_repo_label:
A callable that returns the label used to link to the repository.WarningThis extension is still in development.
It is only tested on Firefox.
Breaking changes may occur in future.There areseveral major limitationsincluding:Local-storage is limited by quotas imposed by the browser.A repository ID and path of the notebook within Jupyter Notebook are used, joined by a.
This may change in future.Development notesThis extension stores notebooks in browser storage using theIndexedDB API, wrapped withDexie.js.One server API call is made during initialisation to obtain the storage configuration.
Everything else is done client-side so should work even if the server is disconnected.The CI pipeline builds the extension with JupyterLab 4, but the build package works with JupyterLab 3 and NBclassic.
Install the development dependencies:pip install -r dev-requirements-jl4.txtTo build and install the development version:pip install .This automatically runsjlpm.The notebook and server extensions should be automatically enabled.JupyterLab 3+ supports the installation of extensions as a static package so no further steps are required.Tagged releases of this repository are automatically published toPyPIandNPM.To test that the binder and repo buttons work when developing locally set some placeholder environment variables, e.g.:BINDER_LAUNCH_HOST=http://localhost BINDER_REPO_URL=http://localhost BINDER_PERSISTENT_REQUEST=v2/gh/repo BINDER_REF_URL=http://localhost jupyter-lab --debugIf you make any changes remember to run all linters and auto-formatters:pre-commit run -ajlpm run format