Package: jupyter-archive
jupyter-archiveA 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 tonull).Decompress an archive directly in file browser.Notebok client extension not available.Contributions are welcome.ConfigurationThe server extension has someconfiguration 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_SIZEJA_HANDLER_MAX_BUFFER_LENGTHJA_ARCHIVE_DOWNLOAD_FLUSH_DELAYRequirementsJupyterLab >= 3.0 or Notebook >= 7.0For JupyterLab 2.x, have lookthere.InstallTo install the extension, execute:pipinstalljupyter-archiveOrcondainstall-cconda-forgejupyter-archiveUninstallTo remove the extension, execute:pipuninstalljupyter-archiveOrcondaremovejupyter-archiveTroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyter-archive directory# Install package in development modepipinstall-e".[test]"# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenablejupyter_archive# Rebuild extension Typescript source after making changesjlpmbuildYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.# Watch the source directory in one terminal, automatically rebuilding when neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).By default, thejlpm buildcommand generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:jupyterlabbuild--minimize=FalseLicenseUnder BSD license. SeeLICENSE.AuthorsHadrien Mary:@hadimFrédéric Collonval:@fcollonvalDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablejupyter_archive
pipuninstalljupyter-archiveIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink named@hadim/jupyter-archivewithin that folder.Testing the extensionServer testsThis extension is usingPytestfor Python code testing.Install test dependencies (needed only once):pipinstall-e".[test]"# Each time you install the Python package, you need to restore the front-end extension linkjupyterlabextensiondevelop.--overwriteTo execute them, run:pytest-vv-rap--covjupyter_archiveIntegration testsThis extension usesPlaywrightfor the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.Packaging the extensionSeeRELEASE