Push fix on hello-world

fcollonval · fcollonval · commit 96998d02c15e · 2021-07-07T17:06:06.000+02:00
Fix setup.py
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -9,6 +9,7 @@ on:
 jobs:
   build_extensions:
     runs-on: ${{ matrix.os }}
+    
     strategy:
       fail-fast: false
       matrix:
@@ -31,6 +32,11 @@ jobs:
           - toolbar-button
           - widgets
         os: [ubuntu-latest, macos-latest, windows-latest]
+
+    defaults:
+      run:
+        working-directory: ${{ matrix.example }}
+
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -54,12 +60,10 @@ jobs:
       - name: Check config files
         if: steps.filter.outputs.extension == 'true'
         run: |
-          diff hello-world/tsconfig.json ${EXAMPLE_FOLDER}/tsconfig.json
-          diff hello-world/.eslintignore ${EXAMPLE_FOLDER}/.eslintignore
-          diff hello-world/.eslintrc.js ${EXAMPLE_FOLDER}/.eslintrc.js
-          diff hello-world/.gitignore ${EXAMPLE_FOLDER}/.gitignore
-        env:
-          EXAMPLE_FOLDER: ${{ matrix.example }}
+          diff ../hello-world/tsconfig.json tsconfig.json
+          diff ../hello-world/.eslintignore .eslintignore
+          diff ../hello-world/.eslintrc.js .eslintrc.js
+          diff ../hello-world/.gitignore .gitignore
         shell: bash
       - name: Install node
         if: steps.filter.outputs.extension == 'true'
@@ -92,30 +96,17 @@ jobs:
           python -m pip install --upgrade pip jupyter_packaging~=0.10 jupyterlab~=3.0
       - name: Install the NPM dependencies
         if: steps.filter.outputs.extension == 'true'
-        run: |
-          cd ${EXAMPLE_FOLDER}
-          jlpm
-        env:
-          EXAMPLE_FOLDER: ${{ matrix.example }}
-        shell: bash
+        run: jlpm
       - name: Lint the files
         if: steps.filter.outputs.extension == 'true'
-        run: |
-          cd ${EXAMPLE_FOLDER}
-          jlpm run eslint:check
-        env:
-          EXAMPLE_FOLDER: ${{ matrix.example }}
-        shell: bash
+        run: jlpm run eslint:check
       - name: Build and check by extension
-        if: steps.filter.outputs.extension == 'true'
         run: |
-          cd ${EXAMPLE_FOLDER}
-          pip install .
-          jupyter labextension list 2>&1 | grep -ie "@jupyterlab-examples/*.*OK"
+          pip install . -vvv
+          jupyter labextension list 2>&1 | tee labextension.list
+          cat labextension.list | grep -ie "@jupyterlab-examples/*.*OK"
           python -m jupyterlab.browser_check
           pip uninstall -y $(python setup.py --name)
-        env:
-          EXAMPLE_FOLDER: ${{ matrix.example }}
         shell: bash
 
   build_serverextension:
@@ -201,8 +192,10 @@ jobs:
       - name: Check extension as dev
         if: steps.filter.outputs.extension == 'true' && ( startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS') )
         run: |
-          jupyter server extension list 2>&1 | grep -ie "jlab_ext_example.*OK"
-          jupyter labextension list 2>&1 | grep -ie "@jupyterlab-examples/server-extension.*OK"
+          jupyter server extension list 2>&1 | tee serverextension.list
+          cat serverextension.list | grep -ie "jlab_ext_example.*OK"
+          jupyter labextension list 2>&1 | tee labextension.list
+          cat labextension.list | grep -ie "@jupyterlab-examples/server-extension.*OK"
       - name: Clean extension installation
         if: steps.filter.outputs.extension == 'true'
         run: |
@@ -218,8 +211,10 @@ jobs:
       - name: Check extension as dev
         if: steps.filter.outputs.extension == 'true' && ( startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS') )
         run: |
-          jupyter server extension list 2>&1 | grep -ie "jlab_ext_example.*OK"
-          jupyter labextension list 2>&1 | grep -ie "@jupyterlab-examples/server-extension.*OK"
+          jupyter server extension list 2>&1 | tee serverextension.list
+          cat serverextension.list | grep -ie "jlab_ext_example.*OK"
+          jupyter labextension list 2>&1 | tee labextension.list
+          cat labextension.list | grep -ie "@jupyterlab-examples/server-extension.*OK"
           python -m jupyterlab.browser_check
 
   build_all:
diff --git a/command-palette/setup.py b/command-palette/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/command-palette"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/commands/setup.py b/commands/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/commands"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/context-menu/setup.py b/context-menu/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/context-menu"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/custom-log-console/setup.py b/custom-log-console/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/custom-log-console"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/datagrid/setup.py b/datagrid/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/datagrid"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/hello-world/setup.py b/hello-world/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/hello-world"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/kernel-messaging/setup.py b/kernel-messaging/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/kernel-messaging"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/kernel-output/setup.py b/kernel-output/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/kernel-output"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/launcher/setup.py b/launcher/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/launcher"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/log-messages/setup.py b/log-messages/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/log-messages"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/main-menu/setup.py b/main-menu/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/main-menu"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/react-widget/setup.py b/react-widget/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/react-widget"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/server-extension/README.md b/server-extension/README.md
@@ -498,53 +498,31 @@ jlab_ext_example setup
 import json
 from pathlib import Path
 
-from jupyter_packaging import (
-    create_cmdclass,
-    install_npm,
-    ensure_targets,
-    combine_commands,
-    skip_if_exists,
-)
 import setuptools
 
 HERE = Path(__file__).parent.resolve()
 
 # The name of the project
 name = "jlab_ext_example"
 
-lab_path = HERE / name / "labextension"
+lab_path = (HERE / name / "labextension")
 
 # Representative files that should exist after a successful build
-jstargets = [
+ensured_targets = [
     str(lab_path / "package.json"),
+    str(lab_path / "static/style.js")
 ]
 
-package_data_spec = {name: ["*"]}
-
 labext_name = "@jupyterlab-examples/server-extension"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
     ("etc/jupyter/jupyter_notebook_config.d", "jupyter-config/jupyter_notebook_config.d", "jlab_ext_example.json"),
     ("etc/jupyter/jupyter_server_config.d", "jupyter-config/jupyter_server_config.d", "jlab_ext_example.json"),
+    
 ]
 
-cmdclass = create_cmdclass(
-    "jsdeps", package_data_spec=package_data_spec, data_files_spec=data_files_spec
-)
-
-js_command = combine_commands(
-    install_npm(HERE, build_cmd="build:prod", npm=["jlpm"]),
-    ensure_targets(jstargets),
-)
-
-is_repo = (HERE / ".git").exists()
-if is_repo:
-    cmdclass["jsdeps"] = js_command
-else:
-    cmdclass["jsdeps"] = skip_if_exists(jstargets, js_command)
-
 long_description = (HERE / "README.md").read_text()
 
 # Get the package info from package.json
@@ -554,15 +532,15 @@ setup_args = dict(
     name=name,
     version=pkg_json["version"],
     url=pkg_json["homepage"],
-    author=pkg_json["author"],
+    author=pkg_json["author"]["name"],
+    author_email=pkg_json["author"]["email"],
     description=pkg_json["description"],
     license=pkg_json["license"],
     long_description=long_description,
     long_description_content_type="text/markdown",
-    cmdclass=cmdclass,
     packages=setuptools.find_packages(),
     install_requires=[
-        "jupyterlab~=3.0",
+        "jupyter_server>=1.6,<2"
     ],
     zip_safe=False,
     include_package_data=True,
@@ -581,6 +559,19 @@ setup_args = dict(
     ],
 )
 
+try:
+    from jupyter_packaging import (
+        wrap_installers,
+        npm_builder,
+        get_data_files
+    )
+    post_develop = npm_builder(
+        build_cmd="install:extension", source_dir="src", build_dir=lab_path
+    )
+    setup_args['cmdclass'] = wrap_installers(post_develop=post_develop, ensured_targets=ensured_targets)
+    setup_args['data_files'] = get_data_files(data_files_spec)
+except ImportError as e:
+    pass
 
 if __name__ == "__main__":
     setuptools.setup(**setup_args)
@@ -628,9 +619,9 @@ It will copy the NPM package in the Python package and force it to be copied in
 JupyterLab is looking for frontend extensions when the Python package is installed:
 
 ```py
-# setup.py#L33-L33
+# setup.py#L25-L25
 
-("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
 ```
 
 The last piece of configuration needed is the enabling of the server extension. This is
@@ -652,7 +643,7 @@ done by copying the following JSON file:
 in the appropriate jupyter folder (`etc/jupyter/jupyter_server_config.d`):
 
 ```py
-# setup.py#L36-L36
+# setup.py#L28-L28
 
 ("etc/jupyter/jupyter_server_config.d", "jupyter-config/jupyter_server_config.d", "jlab_ext_example.json"),
 ```
@@ -661,7 +652,7 @@ For backward compatibility with the classical notebook, the old version of that
  (`etc/jupyter/jupyter_notebook_config.d`):
 
 ```py
-# setup.py#L35-L35
+# setup.py#L27-L27
 
 ("etc/jupyter/jupyter_notebook_config.d", "jupyter-config/jupyter_notebook_config.d", "jlab_ext_example.json"),
 ```
diff --git a/server-extension/jupyter-config/jlab_ext_example.json b/server-extension/jupyter-config/jlab_ext_example.json
diff --git a/server-extension/setup.py b/server-extension/setup.py
@@ -22,9 +22,10 @@
 labext_name = "@jupyterlab-examples/server-extension"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),("etc/jupyter/jupyter_server_config.d",
-     "jupyter-config", "jlab_ext_example.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
+    ("etc/jupyter/jupyter_notebook_config.d", "jupyter-config/jupyter_notebook_config.d", "jlab_ext_example.json"),
+    ("etc/jupyter/jupyter_server_config.d", "jupyter-config/jupyter_server_config.d", "jlab_ext_example.json"),
     
 ]
 
diff --git a/settings/setup.py b/settings/setup.py
@@ -22,8 +22,8 @@
 labext_name = "@jupyterlab-examples/settings"
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),
+    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
+    ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),
 ]
 
 long_description = (HERE / "README.md").read_text()
diff --git a/signals/setup.py b/signals/setup.py
diff --git a/state/setup.py b/state/setup.py
diff --git a/widgets/setup.py b/widgets/setup.py

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,8 @@`
`22`	`22`	`labext_name = "@jupyterlab-examples/command-palette"`
`23`	`23`
`24`	`24`	`data_files_spec = [`
`25`		`- ("share/jupyter/labextensions/%s" % labext_name, str(lab_path), "**"),`
`26`		`- ("share/jupyter/labextensions/%s" % labext_name, str(HERE), "install.json"),`
	`25`	`+ ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),`
	`26`	`+ ("share/jupyter/labextensions/%s" % labext_name, str('.'), "install.json"),`
`27`	`27`	`]`
`28`	`28`
`29`	`29`	`long_description = (HERE / "README.md").read_text()`