Merge pull request #122 from martinRenou/update_install_versions

Update install versions

Author: mwcraig

README.md

@@ -8,7 +8,7 @@
 
 The code in the tutorial has been written using Python 3; many of the dependencies may not be available for Python 2.7.
 
-We **strongly recommend** using the Anaconda Python distribution. You can install either the full [anaconda distribution](https://www.continuum.io/downloads) (very extensive, but large) or [miniconda](https://conda.io/miniconda.html) (much smaller, only essential packages).
+We **strongly recommend** using the conda Python distribution. You can install either [miniconda](https://conda.io/miniconda.html) (much smaller, only essential packages) or the full [anaconda distribution](https://www.continuum.io/downloads) (very extensive, but very, very large).
 
 Almost all of the examples will work in either the regular Jupyter notebook or in JupyterLab. The instructions below assume you will be using JupyterLab.
 
@@ -22,12 +22,12 @@ You can do this with either `git clone https://github.com/jupyter-widgets/tutori
 
 ## conda installation instructions
 
-The steps below will get you a working environment.
+The steps below will get you a  working environment.
 
 ```bash
 conda env create -f environment.yml
 
-conda activate widgets-tutorial
+conda activate widgets-tutorial-2021
 
 # Create a kernel for this environment
 ipython kernel install --name widgets-tutorial --display-name widgets-tutorial --sys-prefix
@@ -47,21 +47,6 @@ pip install -r requirements.txt
 ipython kernel install --name widgets-tutorial --display-name widgets-tutorial --sys-prefix
 ```
 
-## Install JupyterLab extensions
-
-In order to install the JupyterLab extensions, you need `nodejs` to be installed. If you use `conda` it should have been already installed for you when you created your environment.
-
-
-If you do not use `conda`, see [https://nodejs.org/en/download/](https://nodejs.org/en/download/) or [https://nodejs.org/en/download/package-manager/](https://nodejs.org/en/download/package-manager/) for download and installation instructions.
-
-
-Now you can install the JupyterLab extensions:
-
-```bash
-# This may take several minutes
-jupyter labextension install @jupyter-widgets/jupyterlab-manager @jupyter-widgets/jupyterlab-sidecar bqplot jupyter-threejs [email protected] ipysheet ipytree ipycanvas jupyter-matplotlib jupyter-vuetify ipyvolume
-```
-
 ## Check your installation
 
 To check your installation, please download the script [install_check.py](https://raw.githubusercontent.com/jupyter-widgets/tutorial/master/install_check.py) and run it:

environment.yml

@@ -1,29 +1,27 @@
-name: widgets-tutorial
+name: widgets-tutorial-2021
 channels:
   - conda-forge
 dependencies:
-  - python=3.8
-  - pip
-  - notebook
+  - bqplot=0.12.29
+  - ipycanvas=0.9.0
+  - ipycytoscape=1.2.2
+  - ipydatagrid=1.0.7
+  - ipygany=0.5.0
+  - ipyleaflet=0.14.0
+  - ipympl=0.7.0
+  - ipytree=0.2.1
+  - ipyvolume=0.6.0a8
+  - ipyvuetify=1.7.0
+  - ipywidgets=7.6
+  - jupyterlab=3
   - numpy
-  - scikit-image
-  - scipy
   - pandas
+  - pip
+  - python=3.8
+  - pythreejs=2.3.0
   - requests
-  - ipywidgets
-  - bqplot
-  - ipyleaflet=0.12.6
-  - pythreejs
-  - ipycanvas
-  - ipyevents
-  - ipysheet
-  - ipytree
-  - ipympl
-  - pywwt
-  - sidecar
-  - voila=0.1
-  - ipyvuetify
-  - voila-vuetify
-  - jupyterlab=2
-  - ipyvolume=0.6.0a6
-  - nodejs=13
+  - scikit-image
+  - scipy
+  - sidecar=0.5.1
+  - voila=0.2.10
+  - voila-vuetify=0.5.2

install_check.py

@@ -1,7 +1,10 @@
+import sys
+import logging
 from subprocess import check_call, CalledProcessError
 
 
-FIX_PREFIX = '----->'
+SUCCESS_PREFIX = '🎉'
+FIX_PREFIX = '⚠️⚠️⚠️ ----->'
 
 tutorial_name = 'Jupyter widget ecosystem'
 
@@ -12,10 +15,10 @@
     'ipyleaflet',
     'ipyvolume',
     'pythreejs',
-    'ipyevents',
-    'ipysheet',
     'ipytree',
-    'pywwt',
+    'ipydatagrid',
+    'ipycytoscape',
+    'ipygany',
     'jupyterlab'
 ]
 
@@ -35,14 +38,12 @@
 success = all(import_result.values())
 
 # List compatible versions for each package
-version_check_packages = {'ipywidgets': ['7.5'],
-                          'notebook': ['6'],
-                          'jupyterlab': ['2'],
-                          'ipyvolume': ['0.6.0-alpha.6'],
+version_check_packages = {'ipywidgets': ['7.6'],
+                          'jupyterlab': ['3'],
                          }
 
 if success:
-    print('\tAll required packages installed')
+    print(f'\t{SUCCESS_PREFIX} All required packages installed')
 else:
     print(FIX_PREFIX, 'Please install these missing packages '
           'for the tutorial "{}":'.format(tutorial_name))
@@ -53,9 +54,9 @@
 
 try:
     check_call(['voila', '--version'])
-    print('\tVoila is correctly installed')
+    print(f'\t{SUCCESS_PREFIX} Voila is correctly installed')
 except CalledProcessError:
-    print('\tVoila is not installed! Please install it by running one '
+    print(f'\t {FIX_PREFIX} Voila is not installed! Please install it by running one '
           'of the following:')
     print('        conda install -c conda-forge voila')
     print('        pip install voila')
@@ -76,7 +77,7 @@ def version_checker(package_name, version, nbextension=None):
         print('        conda install {}={} # if you use conda'.format(package_name, newest))
         print('        pip install {}=={}'.format(package_name, newest))
     else:
-        print('\t{} version is good!'.format(package_name))
+        print(f'\t{SUCCESS_PREFIX} {package_name} version is good!')
 
 
 # Check as many packages as we can...
@@ -90,14 +91,6 @@ def version_checker(package_name, version, nbextension=None):
     ipywidgets_version = ipywidgets.__version__
     version_checker('ipywidgets', ipywidgets_version)
 
-try:
-    import notebook
-except ImportError:
-    pass
-else:
-    notebook_version = notebook.__version__
-    version_checker('notebook', notebook_version)
-
 try:
     import jupyterlab
 except ImportError:
@@ -106,14 +99,6 @@ def version_checker(package_name, version, nbextension=None):
     jupyterlab_version = jupyterlab.__version__
     version_checker('jupyterlab', jupyterlab_version)
 
-try:
-    import ipyvolume
-except ImportError:
-    pass
-else:
-    ipyvolume_version = ipyvolume.__version__
-    version_checker('ipyvolume', ipyvolume_version)
-
 # Check that the appropriate kernel has been created
 
 required_kernel = 'widgets-tutorial'
@@ -127,7 +112,7 @@ def version_checker(package_name, version, nbextension=None):
     print(FIX_PREFIX, 'Please create custom kernel with: ',
           'ipython kernel install --name widgets-tutorial --display-name widgets-tutorial --sys-prefix')
 else:
-    print('\tCustom kernel is correctly installed')
+    print(f'\t{SUCCESS_PREFIX} Custom kernel is correctly installed')
 
 # Check that lab extensions are installed
 
@@ -140,29 +125,40 @@ def version_checker(package_name, version, nbextension=None):
     'jupyter-threejs',
     'jupyter-leaflet',
     'ipyvolume',
-    'ipyevents',
-    'ipysheet',
     'ipytree',
     'ipycanvas',
+    'ipydatagrid',
+    'ipygany',
+    'jupyter-cytoscape',  # for ipycytoscape
     'jupyter-matplotlib',
     'jupyter-vuetify',
 ]
 
+
 try:
-    from jupyterlab.commands import check_extension
+    from jupyterlab.commands import check_extension, AppOptions
+    from jupyterlab_server.config import get_federated_extensions
 except ImportError:
     print(FIX_PREFIX, 'Please install jupyterlab before checking extensions.')
 else:
     missing_extensions = []
 
+    # Fetch federated extensions
+    federated_extensions = get_federated_extensions([sys.base_prefix + '/share/jupyter/labextensions']).keys()
+
+    # JupyterLab be quiet
+    logger = logging.Logger('quiet')
+    logger.setLevel(logging.CRITICAL)
+    app_options = AppOptions(logger=logger)
+
     for extension in lab_extensions:
-        if not check_extension(extension):
+        if not check_extension(extension, app_options=app_options) and extension not in federated_extensions:
             missing_extensions.append(extension)
 
     if missing_extensions:
         print(FIX_PREFIX, 'These lab extensions are missing: ',
               ', '.join(missing_extensions))
-        print(FIX_PREFIX,' Run this to install them: jupyter labextension install ',
-              ' '.join(missing_extensions))
+        print(FIX_PREFIX,' Please try to install the following packages with conda or pip: ',
+              ', '.join(missing_extensions))
     else:
-        print('\tAll extensions are installed!')
+        print(f'\t{SUCCESS_PREFIX} All extensions are installed!')