GitHub - jupyterlab-contrib/jupyter-archive at 2.x (original) (raw)

jupyter-archive

A Jupyterlab extension to make, download and extract archive files.

Features:

• Download selected or current folder as an archive.
• Supported formats: 'zip', 'tar.gz', 'tar.bz2' and 'tar.xz'.
• Archiving and downloading are non-blocking for Jupyter. UI can still be used.
• Archive format can be set in the JLab settings.
• Alternatively, you can choose the format in the file browser menu (the format setting needs to be set to null).
• Decompress an archive directly in file browser.
• Notebok client extension not available. Contributions are welcome.

Prerequisites

• JupyterLab >=2.0.0,<3.0.0

Installation

Using pip:

pip install jupyter-archive jupyter lab build

Using conda:

conda install -c conda-forge nodejs jupyter-archive jupyter lab build

This will install both the server extension and the Jupyterlab extension needed by the plugin.

You can also install the labextension via Jupyterlab's extension manager GUI. Keep in mind that if you use the GUI, you'll still need to install the jupyter-archive server extension via pip or conda.

Development

Install dependencies with conda:

conda env update -f environment.yml

For a development install (requires npm version 4 or later), do the following in the repository directory:

jlpm jlpm build jupyter labextension link .

Install the server extension

pip install -e . jupyter serverextension enable --py jupyter_archive

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 --no-browser --NotebookApp.token=''

Test the server extension:

pytest -v jupyter_archive/tests/

License

Under BSD license. See LICENSE.

Authors

• Hadrien Mary: @hadim
• Frédéric Collonval: @fcollonval

Release a new version

• Install rever and twine: conda install rever twine
• Run: rever <VERSION>