Merge pull request #124 from bokeh/jlab_scratch

Upgrade to JupyterLab by reinitializing project structure

Author: bryevdv

.eslintignore

@@ -0,0 +1,5 @@
+node_modules
+dist
+coverage
+**/*.d.ts
+tests

.eslintrc.js

@@ -0,0 +1,40 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended'
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module'
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    '@typescript-eslint/naming-convention': [
+      'warn',
+      {
+        'selector': 'interface',
+        'format': ['PascalCase'],
+        'custom': {
+          'regex': '^I[A-Z]',
+          'match': true
+        }
+      }
+    ],
+    '@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-namespace': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/quotes': [
+      'error',
+      'single',
+      { avoidEscape: true, allowTemplateLiterals: false }
+    ],
+    curly: ['error', 'all'],
+    semi: ['warn', 'never'],
+    eqeqeq: 'warn',
+    'prefer-arrow-callback': 'error'
+  }
+};

.github/workflows/build.yml

@@ -0,0 +1,54 @@
+name: Build
+
+on:
+  push:
+    branches: main
+  pull_request:
+    branches: '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install node
+      uses: actions/setup-node@v1
+      with:
+       node-version: '12.x'
+    - name: Install Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.7'
+        architecture: 'x64'
+    - name: Setup pip cache
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: pip-3.7-${{ hashFiles('package.json') }}
+        restore-keys: |
+          pip-3.7-
+          pip-
+
+    - name: Get yarn cache directory path
+      id: yarn-cache-dir-path
+      run: echo "::set-output name=dir::$(yarn cache dir)"
+    - name: Setup yarn cache
+      uses: actions/cache@v2
+      id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+      with:
+        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+        key: yarn-${{ hashFiles('**/yarn.lock') }}
+        restore-keys: |
+          yarn-
+    
+    - name: Install dependencies
+      run: python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.7.9
+    - name: Build the extension
+      run: |
+        jlpm
+        jlpm run eslint:check
+        python -m pip install .
+
+        jupyter labextension list 2>&1 | grep -ie "@bokeh/jupyter_bokeh.*OK"
+        python -m jupyterlab.browser_check

.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+jupyter_bokeh
+src/extension.ts

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "trailingComma": "none",
+  "arrowParens": "avoid",
+  "semi": false
+}

.travis.yml

@@ -1,4 +1,25 @@
+include LICENSE
 include README.md
-include LICENSE.txt
-include jupyter_bokeh.json
-recursive-include jupyter_bokeh/nbextension/static *.js *.js.map *.d.ts
+include pyproject.toml
+include jupyter-config/jupyter_bokeh.json
+
+include package.json
+include install.json
+include ts*.json
+include yarn.lock
+
+recursive-include jupyter_bokeh/nbextension/ *.js *.js.map *.d.ts
+graft jupyter_bokeh/labextension
+
+# Javascript files
+graft src
+graft style
+prune **/node_modules
+prune lib
+
+# Patterns to exclude from any directory
+global-exclude *~
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude .git
+global-exclude .ipynb_checkpoints

MANIFEST.in

@@ -1,36 +1,37 @@
 # jupyter_bokeh
 
-A Jupyter extension for rendering [Bokeh](https://bokeh.org) content within Jupyter.  See also the separate [ipywidgets_bokeh](https://github.com/bokeh/ipywidgets_bokeh) library for support for using Jupyter widgets/ipywidgets objects within Bokeh applications.
+![Github Actions Status](https://github.com/bokeh/jupyter_bokeh/workflows/Build/badge.svg)
 
-## Prerequisites
+A Jupyter extension for rendering [Bokeh](https://bokeh.org) content within Jupyter.  See also the separate [ipywidgets_bokeh](https://github.com/bokeh/ipywidgets_bokeh) library for support for using Jupyter widgets/ipywidgets objects within Bokeh applications.
 
-* Jupyter Lab or Notebook
 
-## Installation
+## Install
 
 To install the latest version in Jupyter Lab:
 
 ```bash
+pip install jupyter_bokeh
+```
+
+or
+
+```
 conda install -c bokeh jupyter_bokeh
-jupyter labextension install @jupyter-widgets/jupyterlab-manager
-jupyter labextension install @bokeh/jupyter_bokeh
 ```
 
-To install a specific version:
+For versions of Jupyter Lab <3.0 you must install the labextension
+separately:
 
 ```bash
-jupyter labextension install @bokeh/[email protected]
+conda install -c bokeh jupyter_bokeh
+jupyter labextension install @jupyter-widgets/jupyterlab-manager
+jupyter labextension install @bokeh/jupyter_bokeh
 ```
 
-On slow or limited memory systems, one can use `--minimize=False` to reduce compilation
-times or make Jupyter Lab build runtime bundles at all.
-
-jupyter_bokeh is automatically installed in Jupyter Notebook. In case of a non-standard
-setup, one can install the extensions with:
+To install a specific version:
 
 ```bash
-jupyter nbextension install --sys-prefix --symlink --py jupyter_bokeh
-jupyter nbextension enable jupyter_bokeh --py --sys-prefix
+jupyter labextension install @bokeh/[email protected]
 ```
 
 ## Compatibility
@@ -53,41 +54,48 @@ installation may refer to the below table.
 | 0.35.x        | 0.6.3            |
 | 1.0.x         | 1.0.0            |
 | 2.0.x         | 2.0.0            |
+| 3.0.x         | 3.0.0            |
 
-## Development
+## Contributing
 
-For a development install (requires npm version 6 or later), do the following in the repository directory:
+### Development install
 
-```bash
-npm install
-jupyter labextension link .
-```
+Note: You will need NodeJS to build the extension package.
 
-To rebuild the package and the JupyterLab app:
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
 
 ```bash
-npm run build
-jupyter lab build
+# Clone the repo to your local environment
+# Change directory to the jupyter_bokeh directory
+# Install package in development mode
+pip install -e .
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Rebuild extension Typescript source after making changes
+jlpm run build
 ```
 
-To incrementally rebuild the extension and JupyterLab after changes you can run
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
 
 ```bash
-npm run watch
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm run watch
+# Run JupyterLab in another terminal
+jupyter lab
 ```
 
-and in another terminal run
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
 
 ```bash
-jupyter lab --watch
+jupyter lab build --minimize=False
 ```
 
-When making a new release for compatibility with a new JupyterLab minor release series, please make a minor
-release bump in this extension (i.e. 0.6.3 -> 0.7.0). Conversely, when creating a release for a new feature or bug fix,
-please make a micro release bump (i.e. 0.6.3 -> 0.6.4).
-
-## Testing
+### Uninstall
 
-There is a directory named ``examples`` which contains a collection of notebooks that cover the various ``jupyter_bokeh``
-functionalities. If you update the extension for new JupyterLab releases, please manually execute each and check that the
-expected behavior occurs. If you extend the ``jupyter_bokeh``, please add a new notebook that covers the new functionality.
+```bash
+pip uninstall jupyter_bokeh
+```

README.md

@@ -19,13 +19,18 @@ extra:
 
 requirements:
   build:
+    - jupyter-packaging
+    - jupyterlab
+    - notebook
     - python
     - setuptools
     - nodejs >=10.13.0
   run:
     - python
     - bokeh >=2.0.0
-    - ipywidgets >=7.0.0
+    - ipywidgets >=7.5.0
+  run_constrained:
+    - jupyterlab >=3.0.0,<4
 
 test:
   imports: