Merge pull request #5 from tokk-nv/dev-jlab2-support

Support Jupyter Lab 2.x

MANIFEST.in

@@ -1,38 +1,2 @@
-include LICENSE.txt
-include README.md
-
-include setupbase.py
-include pytest.ini
-include .coverage.rc
-
-include package.json
-include webpack.config.js
-include jupyter_clickable_image_widget/labextension/*.tgz
-
-# Documentation
-graft docs
-exclude docs/\#*
-prune docs/build
-prune docs/gh-pages
-prune docs/dist
-
-# Examples
-graft examples
-
-# Tests
-graft tests
-prune tests/build
-
-# Javascript files
-graft jupyter_clickable_image_widget/nbextension
-graft src
-prune **/node_modules
-prune coverage
-prune lib
-
-# Patterns to exclude from any directory
-global-exclude *~
-global-exclude *.pyc
-global-exclude *.pyo
-global-exclude .git
-global-exclude .ipynb_checkpoints
+recursive-include jupyter_clickable_image_widget/static *.*
+include jupyter_clickable_image_widget.json

README.md

@@ -7,14 +7,14 @@ This repository contains an image widget (much like the ipywidgets.Image), but w
 To install the widget type the following in a terminal
 
 ```bash
-sudo npm install -g typescript
+sudo pip3 install jupyter jupyterlab
+sudo apt-get install nodejs-dev node-gyp libssl1.0-dev
+sudo apt-get install npm
+jupyter labextension install @jupyter-widgets/jupyterlab-manager
 git clone https://github.com/jaybdub/jupyter_clickable_image_widget
 cd jupyter_clickable_image_widget
-sudo python3 setup.py build
-sudo npm run build
-sudo pip3 install .
-sudo jupyter labextension install .
-sudo jupyter labextension install @jupyter-widgets/jupyterlab-manager
+sudo pip3 install -e .
+jupyter labextension install js
 ```
 
 # Usage
@@ -25,7 +25,7 @@ from jupyter_clickable_image_widget import ClickableImageWidget
 
 image_widget = ClickableImageWidget()
 
-def on_message(_, content, _):
+def on_message(_, content, ignore):
     if content['event'] == 'click':
         data = content['eventData']
         alt_key = data['altKey']

RELEASE.md

@@ -0,0 +1,22 @@
+- To release a new version of jupyter_clickable_image_widget on PyPI:
+
+Update _version.py (set release version, remove 'dev')
+git add the _version.py file and git commit
+`python setup.py sdist upload`
+`python setup.py bdist_wheel upload`
+`git tag -a X.X.X -m 'comment'`
+Update _version.py (add 'dev' and increment minor)
+git add and git commit
+git push
+git push --tags
+
+- To release a new version of jupyter_clickable_image_widget on NPM:
+
+Update `js/package.json` with new npm package version
+
+```
+# clean out the `dist` and `node_modules` directories
+git clean -fdx
+npm install
+npm publish
+```