Compile standalone extension with builder to avoid intrusive builds for JLab

Author: zhihanyue

.gitignore

@@ -2,7 +2,9 @@ build/
 dist/
 node_modules/
 package-lock.json
-/qgrid/static/
+/js/static
+/js/static_nb
 *.egg-info/
 /clean.sh
 __pycache__/
+.*

MANIFEST.in

@@ -1,5 +1,3 @@
 include README.rst
 include LICENSE
-include requirements*.txt
-
-recursive-include qgrid/static *.*
+include requirements.txt

install.json

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

js/package.json

@@ -16,10 +16,11 @@
   ],
   "scripts": {
     "clean": "rimraf dist/",
-    "prepare": "webpack",
+    "prepare": "webpack && jupyter labextension build .",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "devDependencies": {
+    "@jupyterlab/builder": "^4",
     "css-loader": "^6.10.0",
     "expose-loader": "^5.0.0",
     "file-loader": "^6.2.0",
@@ -31,7 +32,7 @@
     "webpack-cli": "^5.1.4"
   },
   "dependencies": {
-    "@jupyter-widgets/base": "^6.0.6",
+    "@jupyter-widgets/base": "^6",
     "@jupyter-widgets/controls": "^3.1.5",
     "jquery": "^3.7.1",
     "jquery-ui-dist": "^1.13.2",

js/webpack.config.js

@@ -38,7 +38,7 @@ module.exports = [
         entry: './src/extension.js',
         output: {
             filename: 'extension.js',
-            path: path.resolve(__dirname, '..', 'qgrid', 'static'),
+            path: path.resolve(__dirname, 'static_nb'),
             libraryTarget: 'amd'
         },
         plugins: plugins,
@@ -53,7 +53,7 @@ module.exports = [
         entry: './src/index.js',
         output: {
             filename: 'index.js',
-            path: path.resolve(__dirname, '..', 'qgrid', 'static'),
+            path: path.resolve(__dirname, 'static_nb'),
             libraryTarget: 'amd'
         },
         devtool: 'source-map',

qgrid/__init__.py

@@ -18,8 +18,8 @@ def _jupyter_nbextension_paths():
         {
             "section": "notebook",
             "src": "static",
-            "dest": "qgrid",
-            "require": "qgrid/extension",
+            "dest": "qgridnext",
+            "require": "qgridnext/extension",
         }
     ]
 

qgridnext.json

@@ -0,0 +1,5 @@
+{
+    "load_extensions": {
+        "qgridnext/extension": true
+    }
+}

setup.py

@@ -1,11 +1,12 @@
-from setuptools import setup, find_packages, Command
+from setuptools import setup, find_packages, Command, find_namespace_packages
 from setuptools.command.sdist import sdist
 from setuptools.command.build_py import build_py
 from setuptools.command.egg_info import egg_info
 from subprocess import check_call
 import os
 import sys
 import platform
+from glob import glob
 from os.path import (
     join, dirname, abspath, exists
 )
@@ -68,8 +69,8 @@ class NPM(Command):
     node_modules = join(node_root, 'node_modules')
 
     targets = [
-        join(here, 'qgrid', 'static', 'extension.js'),
-        join(here, 'qgrid', 'static', 'index.js')
+        join(here, 'js', 'static_nb', 'extension.js'),
+        join(here, 'js', 'static_nb', 'index.js')
     ]
 
     def initialize_options(self):
@@ -122,31 +123,27 @@ def read_requirements(basename):
     with open(reqs_file) as f:
         return [req.strip() for req in f.readlines()]
 
-def package_files(directory):
-    paths = []
-    for (path, directories, filenames) in os.walk(directory):
-        for filename in filenames:
-            paths.append(os.path.join(path, filename))
-    return paths
-
 setup_args = {
     'name': 'qgridnext',
     'version': version_ns['__version__'],
     'description': 'An Interactive Grid for Sorting and Filtering DataFrames in Jupyter',
     'long_description': LONG_DESCRIPTION,
     'include_package_data': True,
     'data_files': [
-        ('share/jupyter/nbextensions/qgrid', package_files('qgrid/static')),
+        ('etc/jupyter/nbconfig/notebook.d' , ['qgridnext.json']),
+        ('share/jupyter/nbextensions/qgridnext', glob('js/static_nb/*.*')),
+        ('share/jupyter/labextensions/qgridnext', glob('js/static/*.*') + ['install.json']),
+        ('share/jupyter/labextensions/qgridnext/static', glob('js/static/static/*.*'))
     ],
-    "python_requires": ">=3.6",
+    "python_requires": ">=3.7",
     'install_requires': read_requirements('requirements.txt'),
     'extras_require': {
         "test": [
             "pytest>=2.8.5",
             "flake8>=3.6.0"
         ],
     },
-    'packages': find_packages(exclude=['qgrid.static']),
+    'packages': find_packages(),
     'zip_safe': False,
     'cmdclass': {
         'build_py': js_prerelease(build_py),
@@ -157,7 +154,7 @@ def package_files(directory):
 
     'author': 'Quantopian Inc.',
     'author_email': '[email protected]',
-    'url': 'https://github.com/quantopian/qgrid',
+    'url': 'https://github.com/zhihanyue/qgridnext',
     'license': 'Apache-2.0',
     'keywords': [
         'ipython',
@@ -173,7 +170,6 @@ def package_files(directory):
         'Topic :: Scientific/Engineering :: Information Analysis',
         'Topic :: Multimedia :: Graphics',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',