Merge pull request #121 from krassowski/pep-8-name

Update in line with latest 3.0 cookiecutter, use PEP8 package name

Author: cameron-toy

.github/workflows/build.yml

@@ -22,7 +22,7 @@ jobs:
         python-version: '3.7'
         architecture: 'x64'
     - name: Install dependencies
-      run: python -m pip install -U pip jupyterlab~=3.0 jupyter-packaging~=0.7.9
+      run: python -m pip install -U jupyterlab~=3.0 jupyter-packaging~=0.7.9
     - name: Build the extension
       run: |
         jlpm
@@ -31,8 +31,5 @@ jobs:
 
         python -m pip install .
 
-        jupyter labextension list 1>labextensions 2>&1
-        cat labextensions | grep "jupyterlab-interactive-dashboard-editor.*OK"
-
+        jupyter labextension list 2>&1 | grep -ie "jupyterlab-interactive-dashboard-editor.*OK"
         python -m jupyterlab.browser_check
-

.gitignore

@@ -5,7 +5,7 @@ node_modules/
 .ipynb_checkpoints
 *.tsbuildinfo
 
-jupyterlab_interactive_dashboard_editor/labextension
+jupyterlab-interactive-dashboard-editor/labextension
 
 */labextension/*.tgz
 # Created by https://www.gitignore.io/api/python
@@ -115,4 +115,4 @@ dmypy.json
 .vscode
 
 # Local testing
-__test/
+__test/

.prettierignore

@@ -2,6 +2,6 @@ node_modules
 **/node_modules
 **/lib
 **/package.json
-jupyterlab_interactive_dashboard_editor
+jupyterlab-interactive-dashboard-editor
 .vscode
-.github
+.github

MANIFEST.in

@@ -3,4 +3,22 @@ include README.md
 include pyproject.toml
 include install.json
 
-graft jupyterlab_interactive_dashboard_editor/labextension
+include package.json
+include install.json
+include ts*.json
+include yarn.lock
+
+graft jupyterlab-interactive-dashboard-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

@@ -57,48 +57,69 @@ And edit them again!
 
 ## Install
 
-Note: You will need NodeJS to install the extension.
+For JupyterLab 3+:
 
 ```bash
-pip install jupyterlab_interactive_dashboard_editor
+pip install jupyterlab-interactive-dashboard-editor
+```
+
+For JupyterLab 2.x:
+
+```bash
+jupyter labextension install jupyterlab-interactive-dashboard-editor
 jupyter lab build
 ```
 
-### Install
+Note: You will need NodeJS to install the extension for JupterLab 2.x.
+
+## Contributing
+
+### 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-interactive-dashboard-editor directory
-
-# Install dependencies
-jlpm
-# Build Typescript source
-jlpm build
+# Change directory to the jupyterlab-interactive-dashboard-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 -interactive-dashboard-editor
+```
+
+For JupyterLab 2.x:
+
 ```bash
 jupyter labextension uninstall jupyterlab-interactive-dashboard-editor
 ```

binder/postBuild

@@ -10,7 +10,7 @@ rm -rf design
 rm -rf .github
 rm -rf binder
 rm -rf docs
-rm -rf jupyterlab_interactive_dashboard_editor
+rm -rf jupyterlab-interactive-dashboard-editor
 rm package.json
 rm tsconfig.json
 rm yarn.lock

docs/getting_started/installation.rst

@@ -9,41 +9,64 @@ JupyterLab >= 2.0
 
 Install
 ~~~~~~~
-Note: You will need NodeJS to install the extension.
+For JupyterLab 3+:
 
 .. code:: bash
 
-    pip install jupyterlab_interactive_dashboard_editor
+    pip install jupyterlab-interactive-dashboard-editor
+
+For JupyterLab 2.x:
+
+.. code:: bash
+
+    jupyter labextension install jupyterlab-interactive-dashboard-editor
     jupyter lab build
 
+Note: You will need NodeJS to install the extension for JupyterLab 2.x.
+
+Developement install:
+
 .. code:: bash
 
     # Clone the repo to your local environment
     # Move to jupyterlab-interactive-dashboard-editor directory
 
-    # Install dependencies
-    jlpm
-    # Build Typescript source
-    jlpm build
+    # Clone the repo to your local environment
+    # Change directory to the jupyterlab-interactive-dashboard-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.
 
 .. code:: 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
+
+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:
+
+.. code:: bash
+    jupyter lab build --minimize=False
 
-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).
 
 Uninstall
 ~~~~~~~~~
+
+For JupyterLab 3+:
+
+.. code:: bash
+    pip uninstall jupyterlab-interactive-dashboard-editor
+
+For JupyterLab 2.x:
+
 .. code:: bash
-jupyter labextension uninstall jupyterlab-interactive-dashboard-editor
+    jupyter labextension uninstall jupyterlab-interactive-dashboard-editor

install.json

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

jupyterlab-interactive-dashboard-editor/__init__.py

@@ -0,0 +1,16 @@
+
+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-interactive-dashboard-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()
+