Clean setup using jupyter-packaging

Signed-off-by: martinRenou <[email protected]>

Author: martinRenou

MANIFEST.in

@@ -1,5 +1,9 @@
 recursive-include ipympl/static *.*
+
 include js/*.tgz
 include js/package.json
 include LICENSE
 include jupyter-matplotlib.json
+
+include setup.py
+include pyproject.toml

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["jupyter_packaging~=0.7.0", "setuptools>=40.8.0", "wheel"]
+build-backend = "setuptools.build_meta"

setup.py

@@ -1,167 +1,63 @@
 from __future__ import print_function
 from distutils import log
-from setuptools import setup, find_packages, Command
+from setuptools import setup, find_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 json
-import sys
-from os.path import join as pjoin
+
+from jupyter_packaging import (
+    create_cmdclass,
+    install_npm,
+    ensure_targets,
+    combine_commands,
+    get_version,
+)
 
 # Name of the project
 name = 'ipympl'
 
 here = os.path.dirname(os.path.abspath(__file__))
-node_root = pjoin(here, 'js')
-is_repo = os.path.exists(pjoin(here, '.git'))
-
-npm_path = os.pathsep.join([
-    pjoin(node_root, 'node_modules', '.bin'),
-    os.environ.get('PATH', os.defpath),
-])
+long_description = 'Matplotlib Jupyter Extension'
 
 log.info('setup.py entered')
 log.info('$PATH=%s' % os.environ['PATH'])
 
-LONG_DESCRIPTION = 'Matplotlib Jupyter Extension'
-
-
-def js_prerelease(command, strict=False):
-    """decorator for building minified js/css prior to another command"""
-    class DecoratedCommand(command):
-        def run(self):
-            jsdeps = self.distribution.get_command_obj('jsdeps')
-            if not is_repo and all(os.path.exists(t) for t in jsdeps.targets):
-                # sdist, nothing to do
-                command.run(self)
-                return
-
-            try:
-                self.distribution.run_command('jsdeps')
-            except Exception as e:
-                missing = [t for t in jsdeps.targets if not os.path.exists(t)]
-                if strict or missing:
-                    log.warn('rebuilding js and css failed')
-                    if missing:
-                        log.error('missing files: %s' % missing)
-                    raise e
-                else:
-                    log.warn('rebuilding js and css failed (not a problem)')
-                    log.warn(str(e))
-            command.run(self)
-            update_package_data(self.distribution)
-    return DecoratedCommand
-
-
-def update_package_data(distribution):
-    """update package_data to catch changes during setup"""
-    build_py = distribution.get_command_obj('build_py')
-    distribution.data_files = get_data_files()
-    # re-init build_py options which load package_data
-    build_py.finalize_options()
-
-
-def get_data_files():
-    """Get the data files for the package.
-    """
-    with open(pjoin(node_root, 'package.json')) as f:
-        package_json = json.load(f)
-    tgz = '%s-%s.tgz' % (package_json['name'], package_json['version'])
-
-    return [
-        ('share/jupyter/nbextensions/jupyter-matplotlib', [
-            'ipympl/static/extension.js',
-            'ipympl/static/index.js',
-            'ipympl/static/index.js.map',
-            'ipympl/static/package.json'
-        ]),
-        ('etc/jupyter/nbconfig/notebook.d', ['jupyter-matplotlib.json']),
-        ('share/jupyter/lab/extensions', ['js/' + tgz]),
-    ]
-
+# Get ipympl version
+version = get_version(os.path.join(name, '_version.py'))
 
-class NPM(Command):
-    description = 'install package.json dependencies using npm'
+js_dir = os.path.join(here, 'js')
 
-    user_options = []
+# Representative files that should exist after a successful build
+jstargets = [
+    os.path.join(js_dir, 'dist', 'index.js'),
+]
 
-    node_modules = pjoin(node_root, 'node_modules')
+data_files_spec = [
+    ('share/jupyter/nbextensions/jupyter-matplotlib', 'ipympl/static', '*.*'),
+    ('etc/jupyter/nbconfig/notebook.d', '.', 'jupyter-matplotlib.json'),
+]
 
-    targets = [
-        pjoin(here, 'ipympl', 'static', 'extension.js'),
-        pjoin(here, 'ipympl', 'static', 'index.js'),
-        pjoin(here, 'ipympl', 'static', 'package.json')
-    ]
-
-    def initialize_options(self):
-        pass
-
-    def finalize_options(self):
-        pass
-
-    def has_npm(self):
-        try:
-            check_call(['npm', '--version'])
-            return True
-        except Exception:
-            return False
-
-    def run(self):
-        has_npm = self.has_npm()
-        if not has_npm:
-            log.error("`npm` unavailable.  If you're running this command "
-                      "using sudo, make sure `npm` is available to sudo")
-
-        env = os.environ.copy()
-        env['PATH'] = npm_path
-
-        if self.has_npm():
-            log.info("Installing build dependencies with npm.  "
-                     "This may take a while...")
-            check_call(['npm', 'install'], cwd=node_root, stdout=sys.stdout,
-                       stderr=sys.stderr)
-            check_call(['npm', 'pack'], cwd=node_root, stdout=sys.stdout,
-                       stderr=sys.stderr)
-
-        for t in self.targets:
-            if not os.path.exists(t):
-                msg = 'Missing file: %s' % t
-                if not has_npm:
-                    msg += ('\nnpm is required to build a development version '
-                            'of widgetsnbextension')
-                raise ValueError(msg)
-
-        # update package data in case this created new files
-        update_package_data(self.distribution)
-
-
-version_ns = {}
-with open(pjoin(here, 'ipympl', '_version.py')) as f:
-    exec(f.read(), {}, version_ns)
+cmdclass = create_cmdclass('jsdeps', data_files_spec=data_files_spec)
+cmdclass['jsdeps'] = combine_commands(
+    install_npm(js_dir, build_cmd='build'), ensure_targets(jstargets),
+)
 
 setup_args = dict(
     name=name,
-    version=version_ns['__version__'],
+    version=version,
     description='Matplotlib Jupyter Extension',
-    long_description=LONG_DESCRIPTION,
+    long_description=long_description,
     license='BSD License',
     include_package_data=True,
-    data_files=get_data_files(),
     install_requires=[
         'ipykernel>=4.7',
         'ipywidgets>=7.5.0',
         'matplotlib>=2.0.0'
     ],
     packages=find_packages(),
     zip_safe=False,
-    cmdclass={
-        'build_py': js_prerelease(build_py),
-        'egg_info': js_prerelease(egg_info),
-        'sdist': js_prerelease(sdist, strict=True),
-        'jsdeps': NPM,
-    },
+    cmdclass=cmdclass,
     author='Matplotlib Development Team',
     author_email='[email protected]',
     url='http://matplotlib.org',