Skip to main content

jupyter-archive

Extension status Github Actions Status Binder Version PyPI Conda (channel only)

A Jupyter 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.

jupyter-archive in action

Configuration

The server extension has some configuration settings -- the values below are the default one:

{
  JupyterArchive: {
    stream_max_buffer_size: 104857600, // The max size of tornado IOStream buffer
    handler_max_buffer_length: 10240, // The max length of chunks in tornado RequestHandler
    archive_download_flush_delay: 100 // The delay in ms at which we send the chunk of data to the client.
  }
}

You can also set new values with the following environment variables:

  • JA_IOSTREAM_MAX_BUFFER_SIZE
  • JA_HANDLER_MAX_BUFFER_LENGTH
  • JA_ARCHIVE_DOWNLOAD_FLUSH_DELAY

Requirements

  • JupyterLab >= 3.0 or Notebook >= 7.0

For JupyterLab 2.x, have look there.

Install

To install the extension, execute:

pip install jupyter-archive

Or

conda install -c conda-forge jupyter-archive

Uninstall

To remove the extension, execute:

pip uninstall jupyter-archive

Or

conda remove jupyter-archive

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Contributing

If you would like to contribute to this extension, please refer to the Contributing Guide.

License

Under BSD license. See LICENSE.

Authors

Release files for jupyter-archive 3.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jupyter-archive 3.5.1
File Size Uploaded
jupyter_archive-3.5.1.tar.gz 385.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for jupyter-archive 3.5.1
File Interpreter ABI Platform
jupyter_archive-3.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 413.1 kB

Release files / jupyter_archive-3.5.1.tar.gz

Download URL jupyter_archive-3.5.1.tar.gz
Size 385.1 kB
Tags Source
SHA-256 checksum
How to use checksums
ca6e5eefbc562fe0c7709f1da3027c66cccc0eac35b5d31efe337abc637bd859
BLAKE2b-256 checksum
How to use checksums
d93ddd3a42099cb08242f1278230e970820c4555a6df3b3a7aec137e66f8f513
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.12.13

Release files / jupyter_archive-3.5.1-py3-none-any.whl

Download URL jupyter_archive-3.5.1-py3-none-any.whl
Size 28.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f232dda22f322d0ac4785fb04bfdf7c914434509d045eec8836acd8b868bc23a
BLAKE2b-256 checksum
How to use checksums
fc640f30f782135c8d99513d9b608a9c68f4684fd4577096e082c719516c3558
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.12.13

Release history Release notifications | RSS feed

This release

3.5.1 This release

2 release files

3.5.0

2 release files

3.4.0

2 release files

3.3.4

2 release files

3.3.3

2 release files

3.3.2

2 release files

3.3.1

2 release files

3.3.0

2 release files

3.2.1

2 release files

3.2.0

2 release files

3.1.0

2 release files

3.0.3

2 release files

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.3.1

2 release files

2.2.0

2 release files

2.0.0

2 release files

0.7.0

1 release file

0.6.2

1 release file

0.5.5

1 release file

0.5.4

1 release file

0.5.2

1 release file

0.5.1

1 release file

0.4.10

1 release file

0.4.9

1 release file

0.4.8

1 release file

0.4.6

1 release file

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page