Merge pull request #5 from vidartf/fixes

Fixes and cleanup

Author: vidartf

README.md

@@ -1,13 +1,14 @@
-# opinionated-widget-cookiecutter
+# widget-ts-cookiecutter
+
 #### A cookiecutter template for creating a custom Jupyter widget project
 
 A [cookiecutter](https://github.com/audreyr/cookiecutter) template for a custom
 Jupyter widget project.
 
-## What is widget-cookiecutter?
+## What is widget-ts-cookiecutter?
 
-With **widget-cookiecutter** you can create a custom Jupyter interactive
-widget project with sensible defaults. widget-cookiecutter helps custom widget
+With **widget-ts-cookiecutter** you can create a custom Jupyter interactive
+widget project with sensible defaults. widget-ts-cookiecutter helps custom widget
 authors get started with best practices for the packaging and distribution
 of a custom Jupyter interactive widget library.
 
@@ -17,11 +18,11 @@ Install [cookiecutter](https://github.com/audreyr/cookiecutter):
 
     $ pip install cookiecutter
 
-After installing cookiecutter, use the widget-cookiecutter:
+After installing cookiecutter, use widget-ts-cookiecutter:
 
-    $ cookiecutter https://github.com/vidartf/opinionated-widget-cookiecutter.git
+    $ cookiecutter https://github.com/jupyter-widgets/widget-ts-cookiecutter.git
 
-As widget-cookiecutter runs, you will be asked for basic information about
+As widget-ts-cookiecutter runs, you will be asked for basic information about
 your custom Jupyter widget project. You will be prompted for the following
 information:
 

{{cookiecutter.github_project_name}}/LICENSE.txt

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2017, {{ cookiecutter.author_name }}
+Copyright (c) {% now 'local', '%Y' %}, {{ cookiecutter.author_name }}
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

{{cookiecutter.github_project_name}}/setup.py

@@ -7,14 +7,16 @@
 from __future__ import print_function
 from glob import glob
 from os.path import join as pjoin
-import sys
+
 
 from setupbase import (
     create_cmdclass, install_npm, ensure_targets,
     find_packages, combine_commands, ensure_python,
-    get_version, setup, HERE
+    get_version, HERE
 )
 
+from setuptools import setup
+
 
 # The name of the project
 name = '{{ cookiecutter.python_package_name }}'
@@ -80,33 +82,23 @@
         'Programming Language :: Python :: 3.6',
         'Framework :: Jupyter',
     ],
-)
-
-
-setuptools_args = dict(include_package_data=True)
-install_requires = setuptools_args['install_requires'] = [
-    'ipywidgets>=7.0.0',
-]
-
-extras_require = setuptools_args['extras_require'] = {
-    'test': [
-        'pytest',
-        'pytest-cov',
-        'nbval',
+    include_package_data = True,
+    install_requires = [
+        'ipywidgets>=7.0.0',
     ],
-    'docs': [
-        'sphinx',
-        'recommonmark',
-        'sphinx_rtd_theme'
-    ],
-}
-
-if 'setuptools' in sys.modules:
-    setup_args.update(setuptools_args)
-
-    setup_args.pop('scripts', None)
-
-    setup_args.update(setuptools_args)
+    extras_require = {
+        'test': [
+            'pytest',
+            'pytest-cov',
+            'nbval',
+        ],
+        'examples': [
+            # Any requirements for the examples to run
+        ],
+    },
+    entry_points = {
+    },
+)
 
 if __name__ == '__main__':
     setup(**setup_args)

{{cookiecutter.github_project_name}}/setupbase.py

@@ -25,13 +25,14 @@
 if os.path.exists('MANIFEST'): os.remove('MANIFEST')
 
 
-from distutils.core import setup
 from distutils.cmd import Command
 from distutils.command.build_py import build_py
 from distutils.command.sdist import sdist
-from distutils.dist import Distribution
 from distutils import log
 
+from setuptools.command.develop import develop
+from setuptools.command.bdist_egg import bdist_egg
+
 try:
     from wheel.bdist_wheel import bdist_wheel
 except ImportError:
@@ -69,11 +70,6 @@ def list2cmdline(cmd_list):
     skip_npm = False
 
 
-# For some commands, use setuptools.  Note that we do NOT list install here!
-if 'develop' in sys.argv or any(a.startswith('bdist') for a in sys.argv):
-    import setuptools
-
-
 # ---------------------------------------------------------------------------
 # Public Functions
 # ---------------------------------------------------------------------------
@@ -127,6 +123,17 @@ def update_package_data(distribution):
     build_py.finalize_options()
 
 
+class bdist_egg_disabled(bdist_egg):
+    """Disabled version of bdist_egg
+
+    Prevents setup.py install performing setuptools' default easy_install,
+    which it should never ever do.
+    """
+    def run(self):
+        sys.exit("Aborting implicit building of eggs. Use `pip install .` "
+                 " to install from source.")
+
+
 def create_cmdclass(prerelease_cmd=None, package_data_spec=None,
         data_files_spec=None):
     """Create a command class with the given optional prerelease class.
@@ -162,18 +169,22 @@ def create_cmdclass(prerelease_cmd=None, package_data_spec=None,
     wrapper = functools.partial(_wrap_command, wrapped)
     handle_files = _get_file_handler(package_data_spec, data_files_spec)
 
+    if 'bdist_egg' in sys.argv:
+        egg = wrapper(bdist_egg, strict=True)
+    else:
+        egg = bdist_egg_disabled
+
     cmdclass = dict(
         build_py=wrapper(build_py, strict=is_repo),
+        bdist_egg=egg,
         sdist=wrapper(sdist, strict=True),
-        handle_files=handle_files
+        handle_files=handle_files,
     )
 
     if bdist_wheel:
         cmdclass['bdist_wheel'] = wrapper(bdist_wheel, strict=True)
 
-    if 'develop' in sys.argv:
-        from setuptools.command.develop import develop
-        cmdclass['develop'] = wrapper(develop, strict=True)
+    cmdclass['develop'] = wrapper(develop, strict=True)
     return cmdclass
 
 
@@ -231,6 +242,7 @@ def combine_commands(*commands):
     """Return a Command that combines several commands."""
 
     class CombinedCommand(Command):
+        user_options = []
 
         def initialize_options(self):
             self.commands = []