Merge branch 'master' into single-archive-file-selector

Author: fcollonval

README.md

@@ -5,33 +5,42 @@
 [![Version](https://img.shields.io/npm/v/@hadim/jupyter-archive.svg)](https://www.npmjs.com/package/@hadim/jupyter-archive)
 [![PyPI](https://img.shields.io/pypi/v/jupyter-archive)](https://pypi.org/project/jupyter-archive/)
 
-Make, download and extract archive files.
+A Jupyter/Jupyterlab extension to make, download and extract archive files.
 
-The extension is composed of two extensions:
+Features:
 
-- A Jupyterlab extension (frontend).
-- A Jupyter server extension (backend).
+- 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](https://github.com/hadim/jupyter-archive/issues/21).
 
 ![jupyter-archive in action](./archive.gif "jupyter-archive in action.")
 
-Note that the extension is inspired from [nbzip](https://github.com/data-8/nbzip).
-
 ## Prerequisites
 
 - JupyterLab
 
 ## Installation
 
-This extension is meant to be integrated into Jupyter. In the meantime you can install it with:
+Using `pip`:
 
 ```bash
 pip install jupyter-archive
 jupyter lab build
 ```
 
-This will install both the server extension and the labextension needed by this plugin.
+Using `conda`:
+
+```bash
+conda install jupyter-archive
+```
 
-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 `jupyterlab-archive` server extension via `pip`.
+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 `jupyterlab-archive` server extension via `pip` or `conda`.
 
 ## Development
 
@@ -73,6 +82,11 @@ pytest jupyter_archive/tests/
 
 Under BSD license. See [LICENSE](LICENSE).
 
+## Authors
+
+- Hadrien Mary: [@hadim](https://github.com/hadim)
+- Frédéric Collonval: [@fcollonval](https://github.com/fcollonval)
+
 ## Release a new version
 
 - Install [rever](https://regro.github.io/rever-docs/index.html): `conda install rever`

jupyter_archive/handlers.py

@@ -12,6 +12,17 @@
 # The delay in ms at which we send the chunk of data
 # to the client.
 ARCHIVE_DOWNLOAD_FLUSH_DELAY = 100
+SUPPORTED_FORMAT = [
+    "zip",
+    "tgz",
+    "tar.gz",
+    "tbz",
+    "tbz2",
+    "tar.bz",
+    "tar.bz2",
+    "txz",
+    "tar.xz"
+]
 
 
 class ArchiveStream():
@@ -84,6 +95,9 @@ def get(self, archive_path, include_body=False):
 
         archive_token = self.get_argument('archiveToken')
         archive_format = self.get_argument('archiveFormat', 'zip')
+        if archive_format not in SUPPORTED_FORMAT:
+            self.log.error("Unsupported format {}.".format(archive_format))
+            raise web.HTTPError(404)
 
         archive_path = os.path.join(cm.root_dir, url2path(archive_path))
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hadim/jupyter-archive",
   "version": "0.5.2-dev",
-  "description": "Make, download and extract archive files.",
+  "description": "A Jupyter/Jupyterlab extension to make, download and extract archive files.",
   "keywords": [
     "jupyter",
     "jupyterlab",

schema/archive.json

@@ -3,10 +3,10 @@
   "description": "Archive handler options.",
   "properties": {
     "format": {
-      "type": "string",
-      "enum": ["zip", "tgz", "tar.gz","tbz", "tbz2", "tar.bz", "tar.bz2","txz", "tar.xz"],
+      "type": ["string", "null"],
+      "enum": [null, "zip", "tgz", "tar.gz","tbz", "tbz2", "tar.bz", "tar.bz2","txz", "tar.xz"],
       "title": "Archive format",
-      "description": "Archive format for compressing folder; one of ['zip', 'tgz', 'tar.gz', 'tbz', 'tbz2', 'tar.bz', 'tar.bz2', 'txz', 'tar.xz']",
+      "description": "Archive format for compressing folder; one of [null (submenu), 'zip', 'tgz', 'tar.gz', 'tbz', 'tbz2', 'tar.bz', 'tar.bz2', 'txz', 'tar.xz']",
       "default": "zip"
     }
   },

setup.py

@@ -50,7 +50,7 @@
       author='Hadrien Mary',
       author_email='[email protected]',
       url='https://github.com/hadim/jupyter-archive/',
-      description='Make, download and extract archive files.',
+      description='A Jupyter/Jupyterlab extension to make, download and extract archive files.',
       long_description_content_type='text/markdown',
       cmdclass=cmdclass,
       packages=find_packages(),