Merge pull request #83 from vidartf/setupbase

Use setupbase from jupyter-packaging

Author: jasongrout

LICENSE

@@ -25,3 +25,41 @@ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------------------------------------------------------------------------------
+
+The setupbase.py file is from the jupyter-packaging project:
+https://github.com/jupyter/jupyter-packaging/blob/0bb5d34eee0da3d2b53760ab1371dc0ee9af9b8d/jupyter_packaging/setupbase.py
+
+The license is (from https://github.com/jupyter/jupyter-packaging/blob/0bb5d34eee0da3d2b53760ab1371dc0ee9af9b8d/LICENSE):
+
+BSD 3-Clause License
+
+Copyright (c) 2017, Project Jupyter
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

js/package.json

@@ -10,7 +10,7 @@
  "url": "https://github.com/jovyan/pythreejs.git"
  },
  "scripts": {
- "prepublish": "webpack",
+ "build": "webpack",
  "test": "echo \"Error: no test specified\" && exit 1"
  },
  "devDependencies": {

setup.py

@@ -1,23 +1,15 @@
 # -*- coding: utf-8 -*-
 
 from __future__ import print_function
-from setuptools import setup, find_packages, Command
-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
+from setuptools import setup, find_packages
 import os
 import sys
-import platform
 
-here = os.path.dirname(os.path.abspath(__file__))
-node_root = os.path.join(here, 'js')
-is_repo = os.path.exists(os.path.join(here, '.git'))
+from setupbase import (
+ create_cmdclass,
+ install_npm,
+)
 
-npm_path = os.pathsep.join([
- os.path.join(node_root, 'node_modules', '.bin'),
- os.environ.get('PATH', os.defpath),
-])
 
 from distutils import log
 log.set_verbosity(log.DEBUG)
@@ -26,97 +18,22 @@
 
 LONG_DESCRIPTION = 'A Python/ThreeJS bridge utilizing the Jupyter widget infrastructure.'
 
-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
+here = os.path.abspath(os.path.dirname(sys.argv[0]))
 
-def update_package_data(distribution):
- """update package_data to catch changes during setup"""
- build_py = distribution.get_command_obj('build_py')
- # distribution.package_data = find_package_data()
- # re-init build_py options which load package_data
- build_py.finalize_options()
-
-
-class NPM(Command):
- description = 'install package.json dependencies using npm'
-
- user_options = []
-
- node_modules = os.path.join(node_root, 'node_modules')
-
- targets = [
- os.path.join(here, 'pythreejs', 'static', 'extension.js'),
- os.path.join(here, 'pythreejs', 'static', 'index.js')
- ]
-
- def initialize_options(self):
- pass
-
- def finalize_options(self):
- pass
-
- def has_npm(self):
- try:
- check_call(['npm', '--version'])
- return True
- except:
- return False
-
- def should_run_npm_install(self):
- package_json = os.path.join(node_root, 'package.json')
- node_modules_exists = os.path.exists(self.node_modules)
- return self.has_npm()
-
- 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.should_run_npm_install():
- 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)
- os.utime(self.node_modules, None)
-
- 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(os.path.join(here, 'pythreejs', '_version.py')) as f:
  exec(f.read(), {}, version_ns)
 
+
+cmdclass = create_cmdclass(['js'])
+cmdclass['js'] = install_npm(
+ path=os.path.join(here, 'js'),
+ build_dir=os.path.join(here, 'pythreejs', 'static'),
+ source_dir=os.path.join(here, 'js'),
+)
+
 setup_args = {
  'name': 'pythreejs',
  'version': version_ns['__version__'],
@@ -134,12 +51,7 @@ def run(self):
  'install_requires': ['ipywidgets>=7.0.0a9', 'traittypes'],
  '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': 'PyThreejs Development Team',
  'author_email': 'jason@jasongrout.org',
  'url': 'https://github.com/jovyan/pythreejs',