Updates to project structure to make it compatible with newer versions of jupyter-notebook, jupyter-lab and ipywidgets

Author: jonasrenault

.gitignore

@@ -7,7 +7,8 @@ node_modules/
 pip-wheel-metadata/
 
 # Compiled javascript
-neurolang_ipywidgets/static/
+neurolang_ipywidgets/nbextension/
+neurolang_ipywidgets/labextension/
 
 # OS X
 .DS_Store

MANIFEST.in

@@ -1,3 +1,23 @@
+graft neurolang_ipywidgets/nbextension
+graft neurolang_ipywidgets/labextension
+
+graft js
+graft tests
+prune **/node_modules
+
 recursive-include neurolang_ipywidgets/static *.*
 include neurolang-ipywidgets.json
 recursive-include neurolang_ipywidgets/data *.*
+
+include LICENSE
+include setup.py
+include pyproject.toml
+include install.json
+
+# Patterns to exclude from any directory
+global-exclude *~
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude .git
+global-exclude .ipynb_checkpoints
+global-exclude *.map

README.md

@@ -9,43 +9,22 @@ Installation
 To install use pip:
 
     $ pip install neurolang_ipywidgets
-    $ jupyter nbextension enable --py --sys-prefix neurolang_ipywidgets
-
-To install for jupyterlab:
 
-    $ jupyter labextension install neurolang_ipywidgets
-	
-> To be able to run extensions in jupyterlab:
->
->    $ jupyter labextension install @jupyter-widgets/jupyterlab-manager
->
-> This should be installed before installing neurolang_ipywidgets
-
-For a development installation (requires npm),
+For a development installation (requires [Node.js](https://nodejs.org) and [Yarn version 1](https://classic.yarnpkg.com/)),
 
     $ git clone https://github.com/NeuroLang/neurolang_ipywidgets.git
     $ cd neurolang_ipywidgets
     $ pip install -e .
-    $ jupyter nbextension install --py --symlink --sys-prefix neurolang_ipywidgets
+    $ jupyter nbextension install --py --symlink --overwrite --sys-prefix neurolang_ipywidgets
     $ jupyter nbextension enable --py --sys-prefix neurolang_ipywidgets
-    $ jupyter labextension install js
-
-When actively developing your extension, build Jupyter Lab with the command:
 
-    $ jupyter lab --watch
-	
-This take a minute or so to get started, but then allows you to hot-reload your javascript extension.
-To see a change, save your javascript, watch the terminal for an update.
+When actively developing your extension for JupyterLab, run the command:
 
-Note on first `jupyter lab --watch`, you may need to touch a file to get Jupyter Lab to open.
+    $ jupyter labextension develop --overwrite neurolang_ipywidgets
 
-Using notebook:
-	$ jupyter notebook
-	
-- After making Python code changes, restarting the notebook kernel will be enough to reflect changes
-- After making JavaScript code changes:
+Then you need to rebuild the JS when you make a code change:
 
-   * cd js
-   * npm run build
-   * Refresh browser to reflect changes
+    $ cd js
+    $ yarn run build
 
+You then need to refresh the JupyterLab page when your javascript changes.

examples/nldownloadlink.py

@@ -5,7 +5,7 @@
 #       extension: .py
 #       format_name: light
 #       format_version: '1.5'
-#       jupytext_version: 1.5.1
+#       jupytext_version: 1.11.1
 #   kernelspec:
 #     display_name: Python 3
 #     language: python

examples/nlpapayaviewer.py

@@ -49,3 +49,5 @@
 # ## Reset viewer
 
 nl.reset()
+
+

examples/nlvboxoverlay.py

@@ -100,3 +100,6 @@
 )
 # vb.layout = vb_layout
 vb
+# -
+
+

install.json

@@ -0,0 +1,5 @@
+{
+  "packageManager": "python",
+  "packageName": "neurolang_ipywidgets",
+  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package neurolang_ipywidgets"
+}

js/lib/labplugin.js

@@ -2,7 +2,7 @@ var plugin = require('./index');
 var base = require('@jupyter-widgets/base');
 
 module.exports = {
-  id: 'neurolang-ipywidgets',
+  id: 'neurolang-ipywidgets:plugin',
   requires: [base.IJupyterWidgetRegistry],
   activate: function(app, widgets) {
       widgets.registerWidget({