Made a number of minor improvements and copied some things from the o…

…riginal

cookiecutter project

Signed-off-by: Nick Leaf <[email protected]>

.gitignore

@@ -8,6 +8,7 @@ node_modules/
 
 # Compiled javascript
 ipyparaview/static/
+js/package-lock.json
 
 # OS X
 .DS_Store

README.md

@@ -12,8 +12,12 @@ For a regular user installation:
     $ pip install git+https://github.com/NVIDIA/ipyparaview.git
     $ jupyter nbextension enable --py --sys-prefix ipyparaview
 
+To install for jupyterlab
 
-For a development installation:
+    $ jupyter labextension install @jupyter-widgets/jupyterlab-manager
+    $ jupyter labextension install ipyparaview
+
+For a development installation (requires npm),
 
     $ git clone https://github.com/NVIDIA/ipyparaview.git
     $ cd ipyparaview

build.sh

@@ -1,7 +1,9 @@
 #!/bin/bash
 
-python setup.py build \
-    && pip install -e . \
-    && jupyter nbextension install --py --symlink --sys-prefix ipyparaview \
-    && jupyter nbextension enable --py --sys-prefix ipyparaview \
-    && jupyter labextension install js
+cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+pip install -e . \
+&& jupyter nbextension install --py --symlink --sys-prefix ipyparaview \
+&& jupyter nbextension enable --py --sys-prefix ipyparaview \
+&& jupyter labextension install @jupyter-widgets/jupyterlab-manager \
+&& jupyter labextension install js

ipyparaview/__init__.py

@@ -19,6 +19,22 @@
 from .widgets import *
 
 def _jupyter_nbextension_paths():
+    """Called by Jupyter Notebook Server to detect if it is a valid nbextension and
+    to install the widget
+
+    Returns
+    =======
+    section: The section of the Jupyter Notebook Server to change.
+        Must be 'notebook' for widget extensions
+    src: Source directory name to copy files from. Webpack outputs generated files
+        into this directory and Jupyter Notebook copies from this directory during
+        widget installation
+    dest: Destination directory name to install widget files to. Jupyter Notebook copies
+        from `src` directory into <jupyter path>/nbextensions/<dest> directory
+        during widget installation
+    require: Path to importable AMD Javascript module inside the
+        <jupyter path>/nbextensions/<dest> directory
+    """
     return [{
         'section': 'notebook',
         'src': 'static',

ipyparaview/_version.py

@@ -1,6 +1,9 @@
+# Module version
 version_info = (0, 1, 0, 'alpha', 0)
 
+# Module version stage suffix map
 _specifier_ = {'alpha': 'a', 'beta': 'b', 'candidate': 'rc', 'final': ''}
 
+# Module version accessible using ipyparaview.__version__
 __version__ = '%s.%s.%s%s'%(version_info[0], version_info[1], version_info[2],
   '' if version_info[3]=='final' else _specifier_[version_info[3]]+str(version_info[4]))

js/README.md

@@ -1,4 +1,4 @@
-A widget for interactive server-side ParaView rendering
+iPython widget for server-side ParaView rendering in Jupyter.
 
 Package Install
 ---------------