Repolode
Submit
jupyterlab-contrib

jupyterlab-contrib/jupyter-archive

A JupyterLab extension for creating, downloading and extracting archive files directly in the file browser.

View on GitHub
Stars
90
Forks
18
Open issues
13
Last commit
8 days ago

What is it?

jupyter-archive adds archiving tools to JupyterLab's file browser. You can select a file or folder, or the current directory, and download it as a single archive. Supported formats are zip, tar.gz, tar.bz2 and tar.xz.

Archiving runs in the background, so the JupyterLab interface stays usable while a large folder is being packaged. The default format can be set in the JupyterLab settings, or the format can be chosen from the file browser menu on each download. Archives can also be decompressed in place from the file browser.

The package installs both a server extension and a frontend extension, and is available through pip and conda-forge. Server-side buffer and flush settings can be tuned through configuration options or environment variables. It requires JupyterLab 3.0 or later, or Notebook 7.0 or later.

Key features

  • 01Download a selected item or the current folder as an archive.
  • 02Supports zip, tar.gz, tar.bz2 and tar.xz formats.
  • 03Archiving does not block the JupyterLab interface.
  • 04Default archive format is configurable in JupyterLab settings.
  • 05Extract archives directly from the file browser.

Use cases

  • Downloading a project folder from a remote Jupyter server as one file.
  • Packaging notebook data or results for sharing.
  • Unpacking an uploaded archive without using a terminal.

Quick start

  1. 1

    Install the extension with pip

    pip install jupyter-archive
  2. 2

    Or install it with conda from conda-forge

    conda install -c conda-forge jupyter-archive

Things to know

  • Notebook client extension is not available.

Topics

#jupyterlab#jupyter#jupyterlab-extension#archive#file-management#compression#archiving#jupyterlab-extensions

FAQ

What is jupyter-archive?
A JupyterLab extension for creating, downloading and extracting archive files directly in the file browser. jupyter-archive adds archiving tools to JupyterLab's file browser. You can select a file or folder, or the current directory, and download it as a single archive. Supported formats are zip, tar.gz, tar.bz2 and tar.xz.
Is jupyter-archive free to use? What license does it have?
jupyter-archive is open source under the BSD-3-Clause license. Check the license terms before using it in commercial products.
Is jupyter-archive still maintained?
Actively maintained. The last commit to jupyter-archive was on Oct 30, 2026.
What can I use jupyter-archive for?
Downloading a project folder from a remote Jupyter server as one file. Packaging notebook data or results for sharing. Unpacking an uploaded archive without using a terminal.
How do I install jupyter-archive?
Install the extension with pip: pip install jupyter-archive Or install it with conda from conda-forge: conda install -c conda-forge jupyter-archive
Where can I get jupyter-archive?
The source code and installation instructions are on GitHub: https://github.com/jupyterlab-contrib/jupyter-archive

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects