Merge pull request #3138 from jasongrout/newpackaging

Modernize the packaging for ipywidgets

Author: jtpio

.github/workflows/packaging.yml

@@ -49,24 +49,23 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip wheel
-        python -m pip install setuptools jupyter_packaging "jupyterlab>=3,<4"
+        python -m pip install --upgrade pip wheel build jupyterlab~=3.0
     - name: Build PyPI distributions for ipywidgets
       run: |
-        python setup.py sdist bdist_wheel
+        python -m build
+    - name: Build and link packages
+      run: |
+        yarn install
+        yarn run build
     - name: Build PyPI distributions for jupyterlab_widgets
       run: |
-        jlpm
-        jlpm run build
         cd jupyterlab_widgets
-        python setup.py sdist bdist_wheel
+        python -m build
         cp ./dist/* ../dist
     - name: Build PyPI distributions for widgetsnbextension
       run: |
-        jlpm
-        jlpm run build
         cd widgetsnbextension
-        python setup.py sdist bdist_wheel
+        python -m build
         cp ./dist/* ../dist
     - name: Build checksum file
       run: |

README.md

@@ -69,32 +69,18 @@ Examples of custom widget libraries built upon ipywidgets are
 The stable version of ipywidgets can be installed with [pip](#with-pip) or [conda](#with-conda).
 If using JupyterLab, review the [Front-end extension for JupyterLab](#front-end-extension-for-jupyterlab) section.
 
-### With pip
+With pip:
 
 ```sh
 pip install ipywidgets
-# Skip the next step if using JupyterLab or Classic notebook version 5.3 and above
-jupyter nbextension enable --py --sys-prefix widgetsnbextension
 ```
 
-### With conda
+With conda:
 
 ```sh
 conda install -c conda-forge ipywidgets
 ```
 
-### Front-end extension for JupyterLab
-
-Install the front-end extension to JupyterLab (note that this requires nodejs
-to be installed):
-
-- For JupyterLab 1.0.x and 1.1.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
-- For JupyterLab 1.2.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
-- For JupyterLab 2.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
-
-See the [Installation](docs/source/user_install.md) section of the documentation
-for additional details.
-
 ### Developer install from source
 
 Installing from source is more complicated and requires a developer install,

docs/requirements.txt

@@ -7,3 +7,4 @@ numpy
 recommonmark
 sphinx>=1.4.6
 sphinx_rtd_theme
+packaging

docs/source/conf.py

@@ -35,7 +35,9 @@
 
 _release = {}
 exec(compile(open('../../ipywidgets/_version.py').read(), '../../ipywidgets/_version.py', 'exec'), _release)
-version = '.'.join(map(str, _release['version_info'][:2]))
+from packaging.version import Version
+v = Version(_release['__version__'])
+version = f'{v.major}.{v.minor}'
 release = _release['__version__']
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/dev_release.md

@@ -59,8 +59,8 @@ Lerna will prompt you for version numbers for each of the changed npm packages i
 
 Go into the `jupyterlab_widgets` directory. Change `jupyterlab_widgets/_version.py` to reflect the new version number.
 ```
-python setup.py sdist bdist_wheel
-twine check dist/*
+pip install build
+python -m build
 twine upload dist/*
 ```
 
@@ -73,7 +73,8 @@ curl -s https://pypi.org/pypi/jupyterlab-widgets/json | jq  -r '[.releases[][] |
 
 Go into the `widgetsnbextension` directory. Change `widgetsnbextension/_version.py` to reflect the new version number.
 ```
-python setup.py sdist bdist_wheel
+pip install build
+python -m build
 twine upload dist/*
 ```
 
@@ -87,7 +88,8 @@ curl -s https://pypi.org/pypi/widgetsnbextension/json | jq  -r '[.releases[][] |
 Change `ipywidgets/_version.py` to reflect the new version number, and if necessary, a new `__html_manager_version__`. Change the `install_requires` parameter in `setup.py` reference the new widgetsnbextension version.
 
 ```
-python setup.py sdist bdist_wheel
+pip install build
+python -m build
 twine upload dist/*
 ```
 

ipywidgets/__init__.py

@@ -17,10 +17,11 @@
 accessible as a `value` attribute.
 """
 
-import os
+# Must import __version__ first to avoid errors importing this file during the build process. See https://github.com/pypa/setuptools/issues/1724#issuecomment-627241822
+from ._version import __version__, __protocol_version__, __jupyter_widgets_controls_version__, __jupyter_widgets_base_version__
 
+import os
 from IPython import get_ipython
-from ._version import version_info, __version__, __protocol_version__, __jupyter_widgets_controls_version__, __jupyter_widgets_base_version__
 from .widgets import *
 from traitlets import link, dlink
 

ipywidgets/_version.py

@@ -1,13 +1,7 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-
-version_info = (8, 0, 0, 'alpha', 3)
-
-_specifier_ = {'alpha': 'a', 'beta': 'b', 'candidate': 'rc', 'final': ''}
-
-__version__ = '%s.%s.%s%s'%(version_info[0], version_info[1], version_info[2],
-  '' if version_info[3]=='final' else _specifier_[version_info[3]]+str(version_info[4]))
+__version__ = '8.0.0a3'
 
 __protocol_version__ = '2.0.0'
 

ipywidgets/widgets/tests/test_widget_output.py

@@ -202,7 +202,7 @@ def test_append_display_data():
 
     # Now try appending an Image.
     image_data = b"foobar"
-    image_data_b64 = image_data if sys.version_info[0] < 3 else 'Zm9vYmFy\n'
+    image_data_b64 = 'Zm9vYmFy\n'
 
     widget.append_display_data(Image(image_data, width=123, height=456))
     expected += (

jupyterlab_widgets/setup.cfg

@@ -0,0 +1,32 @@
+[metadata]
+name = jupyterlab_widgets
+version = attr: jupyterlab_widgets._version.__version__
+author = Jupyter Development Team
+author_email = [email protected]
+url = https://github.com/jupyter-widgets/ipywidgets
+description = Jupyter interactive widgets for JupyterLab
+long_description = file: README.md
+long_description_content_type = text/markdown
+license_file = LICENSE
+license = BSD-3-Clause
+platforms = Linux, Mac OS X, Windows
+keywords = Interactive, Interpreter, Shell, Web, notebook, widgets, Jupyter, JupyterLab, JupyterLab3
+classifiers =
+  Intended Audience :: Developers
+  Intended Audience :: System Administrators
+  Intended Audience :: Science/Research
+  License :: OSI Approved :: BSD License
+  Programming Language :: Python
+  Programming Language :: Python :: 3
+  Programming Language :: Python :: 3.6
+  Programming Language :: Python :: 3.7
+  Programming Language :: Python :: 3.8
+  Programming Language :: Python :: 3.9
+  Programming Language :: Python :: 3 :: Only
+  Framework :: Jupyter
+
+[options]
+python_requires = >=3.6
+zip_safe=False
+include_package_data = True
+packages = find:

jupyterlab_widgets/setup.py

@@ -1,44 +1,33 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
 """
 jupyterlab_widgets setup
 """
-import os
-
 from jupyter_packaging import (
     create_cmdclass, install_npm, ensure_targets,
     combine_commands, ensure_python, get_version,
     skip_if_exists
 )
-import setuptools
+from pathlib import Path
+from setuptools import setup
 
-HERE = os.path.abspath(os.path.dirname(__file__))
+HERE = Path(__file__).parent.resolve()
+IS_REPO = (HERE.parent / '.git').exists()
+LAB_PATH = HERE / "jupyterlab_widgets" / "labextension"
 
 # The name of the project
 name = "jupyterlab_widgets"
-
-# Ensure a valid python version
-ensure_python(">=3.6")
-
-# Get our version
-version = get_version(os.path.join(name, "_version.py"))
-
-lab_path = os.path.join(HERE, name, "labextension")
+labext_name = "@jupyter-widgets/jupyterlab-manager"
 
 # Representative files that should exist after a successful build
-jstargets = [
-    os.path.join(lab_path, "package.json"),
-]
+jstargets = [LAB_PATH / "package.json"]
 
-package_data_spec = {
-    name: [
-        "*"
-    ]
-}
-
-labext_name = "@jupyter-widgets/jupyterlab-manager"
+package_data_spec = {name: ["*"]}
 
 data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, lab_path, "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, HERE, "install.json"),
+    (f"share/jupyter/labextensions/{labext_name}", LAB_PATH, "**"),
+    (f"share/jupyter/labextensions/{labext_name}", HERE, "install.json"),
 ]
 
 cmdclass = create_cmdclass(
@@ -55,43 +44,10 @@
     ensure_targets(jstargets),
 )
 
-is_repo = os.path.exists(os.path.join(HERE, os.pardir, ".git"))
-if is_repo:
+if IS_REPO:
     cmdclass["jsdeps"] = js_command
 else:
     cmdclass["jsdeps"] = skip_if_exists(jstargets, js_command)
 
-with open("README.md", "r") as fh:
-    long_description = fh.read()
-
-setup_args = dict(
-    name=name,
-    version=version,
-    url="https://github.com/jupyter-widgets/ipywidgets",
-    author="Jupyter Development Team",
-    description="A JupyterLab extension.",
-    long_description= long_description,
-    long_description_content_type="text/markdown",
-    cmdclass=cmdclass,
-    packages=setuptools.find_packages(),
-    install_requires=[],
-    zip_safe=False,
-    include_package_data=True,
-    python_requires=">=3.6",
-    license="BSD-3-Clause",
-    platforms="Linux, Mac OS X, Windows",
-    keywords=["Jupyter", "JupyterLab", "JupyterLab3"],
-    classifiers=[
-        "License :: OSI Approved :: BSD License",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.6",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Framework :: Jupyter",
-    ],
-)
-
-
 if __name__ == "__main__":
-    setuptools.setup(**setup_args)
+    setup(cmdclass=cmdclass)