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

Author: krassowski

.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

@@ -60,7 +60,7 @@ And edit them again!
 Note: You will need NodeJS to install the extension.
 
 ```bash
-pip install jupyterlab_interactive_dashboard_editor
+pip install jupyterlab-interactive-dashboard-editor
 jupyter lab build
 ```
 

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

@@ -13,7 +13,7 @@ Note: You will need NodeJS to install the extension.
 
 .. code:: bash
 
-    pip install jupyterlab_interactive_dashboard_editor
+    pip install jupyterlab-interactive-dashboard-editor
     jupyter lab build
 
 .. code:: bash

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()
+