Merge pull request #9 from mariobuikhuizen/convert

feat: add script to convert jupyter-boilerplate snippets

Author: mariobuikhuizen

README.md

@@ -28,6 +28,11 @@ In JupyterLab, use the "Snippets" menu to select the snippet:
 
 <img width="570" alt="Schermafbeelding 2020-03-30 om 17 25 31" src="https://user-images.githubusercontent.com/46192475/77930697-8257fd00-72ab-11ea-8a77-36f45d6442d9.png">
 
+## Convert snippets from jupyter-boilerplate format
+
+See [jupyter-boilerplate-converter](jupyter-boilerplate-converter/README.md) on how to convert snippets from the
+[jupyter-boilerplate](https://github.com/moble/jupyter_boilerplate) classic notebook extension (not available for
+JupyterLab) to jupyterlab-snippets.
 
 ## Troubleshoot
 

jupyter-boilerplate-converter/README.md

@@ -0,0 +1,50 @@
+# jupyter-boilerplate-converter
+
+Convert snippets from the [jupyter-boilerplate](https://github.com/moble/jupyter_boilerplate) classic notebook
+extension (not available for JupyterLab) to [jupyterlab-snippets](../README.md).
+
+## Usage
+
+Run the following commands in the `jupyter-boilerplate-converter` directory.
+```
+$ npm install
+$ npm run convert <path/to/boilerplate-snippet.js> <path/to/snippets/dir> [extension]
+```
+
+## Example
+
+Convert built-in jupyter-boilerplate snippets.
+
+Run the following commands in the `jupyter-boilerplate-converter` directory.
+
+Download jupyter-boilerplate from github and list snippets:
+```
+$ git clone git://github.com/moble/jupyter_boilerplate
+$ ls -l jupyter_boilerplate/snippets_submenus_python
+
+astropy.js           matplotlib.js        numpy.js             numpy_ufuncs.js      python.js
+scipy.js             scipy_special.js     sympy_assumptions.js h5py.js              numba.js
+numpy_polynomial.js  pandas.js            python_regex.js      scipy_constants.js   sympy.js
+sympy_functions.js
+```
+
+Find JupyterLab data directories:
+```
+$ jupyter --paths
+
+# Output in MacOs, this will be different on Linux and Windows
+...
+data:
+    /Users/<username>/Library/Jupyter
+    /Users/<username>/miniconda3/envs/<envname>/share/jupyter
+    /usr/local/share/jupyter
+    /usr/local/share/jupyter
+    /usr/share/jupyter
+...
+```
+
+Convert one of the snippets to JupyterLab user-data directory (top directory in the list above):
+```
+$ npm install    #  only required to run once
+$ npm run convert jupyter_boilerplate/snippets_submenus_python/numpy.js ~/Library/Jupyter .py
+```

jupyter-boilerplate-converter/convert.js

@@ -0,0 +1,41 @@
+var requirejs = require('requirejs');
+var fs = require('fs');
+var sanitizeFilename = require('sanitize-filename');
+
+
+const source = process.argv[2];
+const destination = process.argv[3];
+const extension = process.argv[4] || '';
+
+requirejs.config({
+    nodeRequire: require
+});
+require('node-define');
+
+sourceData = require(source);
+
+if (!fs.existsSync(destination)){
+    fs.mkdirSync(destination);
+}
+
+function createLevel(path, data) {
+    if (!data.name) {
+        return
+    }
+    const newPath = `${path}/${sanitizeFilename(data.name)}`;
+
+    if (data.snippet) {
+        fs.writeFile(`${newPath}${extension}`, data.snippet.join('\n'), function (err) {
+            if (err) throw err;
+        });
+    } else if (data['sub-menu']) {
+        if (!fs.existsSync(newPath)){
+            fs.mkdirSync(newPath);
+        }
+        data['sub-menu'].forEach(submenu => {
+            createLevel(newPath, submenu);
+        });
+    }
+}
+
+createLevel(destination, sourceData);

jupyter-boilerplate-converter/package-lock.json

@@ -0,0 +1,16 @@
+{
+  "name": "jupyter-boilerplate-converter",
+  "version": "1.0.0",
+  "description": "jupyter-boilerplate snippets converter",
+  "scripts": {
+    "convert": "node ./convert.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "license": "BSD-3-Clause",
+  "author": "QuantStack",
+  "devDependencies": {
+    "node-define": "^0.1.1",
+    "requirejs": "^2.3.6",
+    "sanitize-filename": "^1.6.3"
+  }
+}