Merge pull request #317 from krassowski/jupyterlab-3

Update for JupyterLab 3.0

Author: loganamcnichols

.eslintrc.js

@@ -12,9 +12,16 @@ module.exports = {
   },
   plugins: ['@typescript-eslint'],
   rules: {
-    '@typescript-eslint/interface-name-prefix': [
+    '@typescript-eslint/naming-convention': [
       'error',
-      { prefixWithI: 'always' }
+      {
+        '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',

.github/workflows/build.yml

@@ -11,13 +11,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
     - name: Install node
       uses: actions/setup-node@v1
       with:
        node-version: '10.x'
     - name: Install Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
       with:
         python-version: '3.7'
         architecture: 'x64'
@@ -27,7 +27,7 @@ jobs:
       run: |
         jlpm
         jlpm run eslint:check
+        python -m pip install .
 
-        jupyter labextension install .
-
+        jupyter labextension list 2>&1 | grep -ie "jupyterlab-tabular-data-editor.*OK"
         python -m jupyterlab.browser_check

.prettierrc

@@ -1,3 +1,5 @@
 {
-  "singleQuote": true
+  "singleQuote": true,
+  "trailingComma": "none",
+  "arrowParens": "avoid"
 }

MANIFEST.in

@@ -0,0 +1,24 @@
+include LICENSE
+include README.md
+include pyproject.toml
+include jupyter-config/jupyterlab-tabular-data-editor.json
+
+include package.json
+include install.json
+include ts*.json
+include yarn.lock
+
+graft jupyterlab-tabular-data-editor/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

README.md

@@ -8,7 +8,7 @@
 
 ### EXPERIMENTAL: This extension is still in alpha. The API is subject to frequent changes.
 
-![](design/gifs/showcase.gif)
+![](https://raw.githubusercontent.com/jupytercalpoly/jupyterlab-tabular-data-editor/master/design/gifs/showcase.gif)
 
 Try our extension [here](https://mybinder.org/v2/gh/jupytercalpoly/jupyterlab-tabular-data-editor/master?urlpath=lab)!
 
@@ -25,31 +25,31 @@ See our progress as of 08/27/2020 from these [slides](https://docs.google.com/pr
 <summary>View Extension Highlights</summary>
 <br>
   <h3>Launch new files and quickly add rows and columns</h3>
-  <img src="design/gifs/csvlauncher.gif" alt="gif of launching a new csv file within JupyterLab">
+  <img src="https://raw.githubusercontent.com/jupytercalpoly/jupyterlab-tabular-data-editor/master/design/gifs/csvlauncher.gif" alt="gif of launching a new csv file within JupyterLab">
 
   <br>
   <br>
 
   <h3>Seamlessly rearrange your data table</h3>
-  <img src="design/gifs/moving.gif" alt="gif of moving rows and columns within JupyterLab">
+  <img src="https://raw.githubusercontent.com/jupytercalpoly/jupyterlab-tabular-data-editor/master/design/gifs/moving.gif" alt="gif of moving rows and columns within JupyterLab">
 
    <br>
    <br>
 
   <h3>Insert and remove multiple rows and columns</h3>
-  <img src="design/gifs/multiremoveandinsert.gif" alt="gif of removing and inserting multiple rows and columns within JupyterLab">
+  <img src="https://raw.githubusercontent.com/jupytercalpoly/jupyterlab-tabular-data-editor/master/design/gifs/multiremoveandinsert.gif" alt="gif of removing and inserting multiple rows and columns within JupyterLab">
 
    <br>
    <br>
 
   <h3>Format your data with a click of a button</h3>
-  <img src="design/gifs/auto-format.gif" alt="gif of toggling on a mode that formats data based on data types within JupyterLab">
+  <img src="https://raw.githubusercontent.com/jupytercalpoly/jupyterlab-tabular-data-editor/master/design/gifs/auto-format.gif" alt="gif of toggling on a mode that formats data based on data types within JupyterLab">
 
    <br>
    <br>
 
   <h3>Search and replace with ease</h3>
-  <img src="design/gifs/searchandreplace.gif" alt="gif of searching and replacing a word within a large file within JupyterLab">
+  <img src="https://raw.githubusercontent.com/jupytercalpoly/jupyterlab-tabular-data-editor/master/design/gifs/searchandreplace.gif" alt="gif of searching and replacing a word within a large file within JupyterLab">
 </details>
 
 ## Requirements
@@ -58,48 +58,66 @@ See our progress as of 08/27/2020 from these [slides](https://docs.google.com/pr
 
 ## Install
 
+JupyterLab 3:
+
+```bash
+pip install jupyterlab-tabular-data-editor
+```
+
+JupyterLab 2:
+
 ```bash
 jupyter labextension install jupyterlab-tabular-data-editor
 ```
 
 ## Contributing
 
-### Install
+### Development install
+
+Note: You will need NodeJS to build the extension package.
 
 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
 # Clone the repo to your local environment
-# Move to jupyterlab-tabular-data-editor directory
-
-# Install dependencies
-jlpm
-# Build Typescript source
-jlpm build
+# Change directory to the jupyterlab-tabular-data-editor directory
+# Install package in development mode
+pip install -e .
 # Link your development version of the extension with JupyterLab
-jupyter labextension install .
-# Rebuild Typescript source after making changes
-jlpm build
-# Rebuild JupyterLab after making any changes
-jupyter lab build
+jupyter labextension develop . --overwrite
+# Rebuild extension Typescript source after making changes
+jlpm run build
 ```
 
-You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
+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
-# Watch the source directory in another terminal tab
-jlpm watch
-# Run jupyterlab in watch mode in one terminal tab
-jupyter lab --watch
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm run watch
+# Run JupyterLab in another terminal
+jupyter lab
 ```
 
-Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).
+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 build --minimize=False
+```
 
 ### Uninstall
 
+For JupyterLab 3:
+
 ```bash
+pip uninstall jupyterlab-tabular-data-editor
+```
+
+For JupyterLab 2:
 
+```bash
 jupyter labextension uninstall jupyterlab-tabular-data-editor
 ```

install.json

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

jest.config.js

@@ -9,7 +9,7 @@ module.exports = {
   setupFiles: ['<rootDir>/testutils/jest-setup-files.js'],
   testPathIgnorePatterns: ['/lib/', '/node_modules/'],
   transformIgnorePatterns: [
-    '/node_modules/(?!(@jupyterlab/.*|tde-csvviewer)/)'
+    '/node_modules/(?!(@jupyterlab/.*)/)'
   ],
 
   globals: {

jupyterlab-tabular-data-editor/__init__.py

@@ -0,0 +1,17 @@
+
+import json
+from pathlib import Path
+
+from ._version import __version__
+
+HERE = Path(__file__).parent.resolve()
+
+with (HERE / "labextension" / "package.json").open() as fid:
+    data = json.load(fid)
+
+def _jupyter_labextension_paths():
+    return [{
+        "src": "labextension",
+        "dest": data["name"]
+    }]
+

jupyterlab-tabular-data-editor/_version.py

@@ -0,0 +1,19 @@
+import json
+from pathlib import Path
+
+__all__ = ["__version__"]
+
+def _fetchVersion():
+    HERE = Path(__file__).parent.resolve()
+
+    for settings in HERE.rglob("package.json"): 
+        try:
+            with settings.open() as f:
+                return json.load(f)["version"]
+        except FileNotFoundError:
+            pass
+
+    raise FileNotFoundError(f"Could not find package.json under dir {HERE!s}")
+
+__version__ = _fetchVersion()
+