Support for installable Python package (wheel) for OpenWeave

-- Added support for building an installable Python wheel (.whl) file that can be used to
install the OpenWeave Python code using pip on any Linux or OS X machine.  The OpenWeave
installable package includes the “openweave” Python module (containing WeaveDeviceManager
and other classes), the associated _WeaveDeviceMgr.so shared library, and the Weave Device
Manager Shell script (weave-device-mgr).  Once installed, the code and tools can be used
without reference to the openweave-core source tree, and without concern as to how the code
locates the shared library.

Building the OpenWeave Python installer requires the Python setuptools and wheel packages to
be installed on the build machine.  The --(enable|disable)-installable-python-package
configure option can be used to control whether the installable package is built.  By
default, the installable package will be built if configure detects that the prerequisite
build packages are available.

Author: Jay Logue

configure

@@ -1,6 +1,6 @@
 #! /bin/sh
 # Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.68 for Weave g212389ac-dirty.
+# Generated by GNU Autoconf 2.68 for Weave g9c6721d9-dirty.
 #
 # Report bugs to <[email protected]>.
 #
@@ -570,8 +570,8 @@ MAKEFLAGS=
 # Identity of this package.
 PACKAGE_NAME='Weave'
 PACKAGE_TARNAME='weave'
-PACKAGE_VERSION='g212389ac-dirty'
-PACKAGE_STRING='Weave g212389ac-dirty'
+PACKAGE_VERSION='g9c6721d9-dirty'
+PACKAGE_STRING='Weave g9c6721d9-dirty'
 PACKAGE_BUGREPORT='[email protected]'
 PACKAGE_URL='https://developer.nest.com/'
 
@@ -699,6 +699,8 @@ WEAVE_FUZZING_ENABLED_FALSE
 WEAVE_FUZZING_ENABLED_TRUE
 WEAVE_WITH_VERHOEFF_FALSE
 WEAVE_WITH_VERHOEFF_TRUE
+WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE_FALSE
+WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE_TRUE
 WEAVE_BUILD_DEVICE_MANAGER_FALSE
 WEAVE_BUILD_DEVICE_MANAGER_TRUE
 INET_CONFIG_ENABLE_ASYNC_DNS_SOCKETS_FALSE
@@ -1071,6 +1073,7 @@ enable_ipv4
 with_inet_endpoint
 enable_adns
 enable_device_manager
+enable_installable_python_package
 enable_verhoeff
 enable_fuzzing
 with_enhanced_printf
@@ -1709,7 +1712,7 @@ if test "$ac_init_help" = "long"; then
   # Omit some internal or obsolete options to make the list less imposing.
   # This message is too long to be a string in the A/UX 3.1 sh.
   cat <<_ACEOF
-\`configure' configures Weave g212389ac-dirty to adapt to many kinds of systems.
+\`configure' configures Weave g9c6721d9-dirty to adapt to many kinds of systems.
 
 Usage: $0 [OPTION]... [VAR=VALUE]...
 
@@ -1780,7 +1783,7 @@ fi
 
 if test -n "$ac_init_help"; then
   case $ac_init_help in
-     short | recursive ) echo "Configuration of Weave g212389ac-dirty:";;
+     short | recursive ) echo "Configuration of Weave g9c6721d9-dirty:";;
    esac
   cat <<\_ACEOF
 
@@ -1842,6 +1845,9 @@ Optional Features:
   --disable-adns          Disable building of adns [default=no].
   --enable-device-manager Enable building of Device Manager wrapper libraries
                           [default=yes].
+  --enable-installable-python-package
+                          Enable building of an installable Python package
+                          (wheel) for OpenWeave [default=yes].
   --enable-verhoeff       Enable Verhoeff support [default=no].
   --enable-fuzzing        Enable Fuzzing - Requires clang 6.0 or greater
                           [default=no].
@@ -2146,7 +2152,7 @@ fi
 test -n "$ac_init_help" && exit $ac_status
 if $ac_init_version; then
   cat <<\_ACEOF
-Weave configure g212389ac-dirty
+Weave configure g9c6721d9-dirty
 generated by GNU Autoconf 2.68
 
 Copyright (C) 2010 Free Software Foundation, Inc.
@@ -3158,7 +3164,7 @@ cat >config.log <<_ACEOF
 This file contains any messages produced by compilers while
 running configure, to aid debugging if configure makes a mistake.
 
-It was created by Weave $as_me g212389ac-dirty, which was
+It was created by Weave $as_me g9c6721d9-dirty, which was
 generated by GNU Autoconf 2.68.  Invocation command line was
 
   $ $0 $@
@@ -4365,7 +4371,7 @@ fi
 
 # Define the identity of the package.
  PACKAGE='weave'
- VERSION='g212389ac-dirty'
+ VERSION='g9c6721d9-dirty'
 
 
 # Some tools Automake needs.
@@ -9294,6 +9300,29 @@ if test "${PYTHON}" = ""; then
     as_fn_error $? "could not find python: python is required to build this package." "$LINENO" 5
 fi
 
+# Check for specific Python packages
+
+{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for Python setuptools package" >&5
+$as_echo_n "checking for Python setuptools package... " >&6; }
+if ${PYTHON} -c 'import setuptools' >/dev/null 2>&1; then
+    have_python_package_setuptools=yes
+else
+    have_python_package_setuptools=no
+fi
+{ $as_echo "$as_me:${as_lineno-$LINENO}: result: ${have_python_package_setuptools}" >&5
+$as_echo "${have_python_package_setuptools}" >&6; }
+
+{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for Python wheel package" >&5
+$as_echo_n "checking for Python wheel package... " >&6; }
+if ${PYTHON} -c 'import wheel' >/dev/null 2>&1; then
+    have_python_package_wheel=yes
+else
+    have_python_package_wheel=no
+fi
+{ $as_echo "$as_me:${as_lineno-$LINENO}: result: ${have_python_package_wheel}" >&5
+$as_echo "${have_python_package_wheel}" >&6; }
+
+
 #
 # Checks for specific compiler characteristics
 #
@@ -24503,7 +24532,7 @@ fi
 # Fail if Device Manager wrapper libraries are enabled but the "sockets" network stack is not.  This combination is
 # not supported.
 if test "${build_device_manager}" = "yes"; then
-    if test "${WEAVE_SYSTEM_CONFIG_USE_SOCKETS}" eq 0; then
+    if test ${WEAVE_SYSTEM_CONFIG_USE_SOCKETS} -eq 0; then
         as_fn_error $? "Building Device Manager wrapper libraries requires selecting sockets as a target network stack" "$LINENO" 5
     fi
 fi
@@ -24520,6 +24549,63 @@ fi
 
 
 
+#
+# OpenWeave Python installable package (wheel)
+#
+
+{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether to build installable Python package for OpenWeave" >&5
+$as_echo_n "checking whether to build installable Python package for OpenWeave... " >&6; }
+# Check whether --enable-installable_python_package was given.
+if test "${enable_installable_python_package+set}" = set; then :
+  enableval=$enable_installable_python_package;
+        case "${enableval}" in
+
+        no|yes)
+            build_installable_python_package=${enableval}
+            ;;
+
+        *)
+            as_fn_error $? "Invalid value ${enableval} for --enable-installable-python-package" "$LINENO" 5
+            ;;
+
+        esac
+
+else
+
+        # By default, enable building an installable Python package iff the setuptools and wheel packages
+        # are available.
+        if test "${have_python_package_setuptools}" == "yes" -a "${have_python_package_wheel}" == "yes"; then
+            build_installable_python_package=yes
+        else
+            build_installable_python_package=no
+        fi
+
+fi
+
+
+# Fail if requested to build an installable Python package but the setuptools and wheel packages
+# are not available
+if test "${build_installable_python_package}" = "yes"; then
+    if test "${have_python_package_setuptools}" != "yes"; then
+        as_fn_error $? "The Python setuptools package must be installed in order to build an installable package for OpenWeave" "$LINENO" 5
+    fi
+    if test "${have_python_package_wheel}" != "yes"; then
+        as_fn_error $? "The Python wheel package must be installed in order to build an installable package for OpenWeave" "$LINENO" 5
+    fi
+fi
+
+{ $as_echo "$as_me:${as_lineno-$LINENO}: result: ${build_installable_python_package}" >&5
+$as_echo "${build_installable_python_package}" >&6; }
+ if test "${build_installable_python_package}" = "yes"; then
+  WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE_TRUE=
+  WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE_FALSE='#'
+else
+  WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE_TRUE='#'
+  WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE_FALSE=
+fi
+
+
+
 #
 # Verhoeff support
 #
@@ -29754,6 +29840,10 @@ if test -z "${WEAVE_BUILD_DEVICE_MANAGER_TRUE}" && test -z "${WEAVE_BUILD_DEVICE
   as_fn_error $? "conditional \"WEAVE_BUILD_DEVICE_MANAGER\" was never defined.
 Usually this means the macro was only invoked conditionally." "$LINENO" 5
 fi
+if test -z "${WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE_TRUE}" && test -z "${WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE_FALSE}"; then
+  as_fn_error $? "conditional \"WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE\" was never defined.
+Usually this means the macro was only invoked conditionally." "$LINENO" 5
+fi
 if test -z "${WEAVE_WITH_VERHOEFF_TRUE}" && test -z "${WEAVE_WITH_VERHOEFF_FALSE}"; then
   as_fn_error $? "conditional \"WEAVE_WITH_VERHOEFF\" was never defined.
 Usually this means the macro was only invoked conditionally." "$LINENO" 5
@@ -30231,7 +30321,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1
 # report actual input values of CONFIG_FILES etc. instead of their
 # values after options handling.
 ac_log="
-This file was extended by Weave $as_me g212389ac-dirty, which was
+This file was extended by Weave $as_me g9c6721d9-dirty, which was
 generated by GNU Autoconf 2.68.  Invocation command line was
 
   CONFIG_FILES    = $CONFIG_FILES
@@ -30298,7 +30388,7 @@ _ACEOF
 cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
 ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
 ac_cs_version="\\
-Weave config.status g212389ac-dirty
+Weave config.status g9c6721d9-dirty
 configured by $0, generated by GNU Autoconf 2.68,
   with options \\"\$ac_cs_config\\"
 

configure.ac

@@ -324,6 +324,25 @@ if test "${PYTHON}" = ""; then
     AC_MSG_ERROR([could not find python: python is required to build this package.])
 fi
 
+# Check for specific Python packages
+
+AC_MSG_CHECKING([for Python setuptools package])
+if ${PYTHON} -c 'import setuptools' >/dev/null 2>&1; then
+    have_python_package_setuptools=yes
+else
+    have_python_package_setuptools=no
+fi
+AC_MSG_RESULT(${have_python_package_setuptools})
+
+AC_MSG_CHECKING([for Python wheel package])
+if ${PYTHON} -c 'import wheel' >/dev/null 2>&1; then
+    have_python_package_wheel=yes
+else
+    have_python_package_wheel=no
+fi
+AC_MSG_RESULT(${have_python_package_wheel})
+
+
 #
 # Checks for specific compiler characteristics
 #
@@ -1692,7 +1711,7 @@ AC_ARG_ENABLE(device_manager,
 # Fail if Device Manager wrapper libraries are enabled but the "sockets" network stack is not.  This combination is
 # not supported. 
 if test "${build_device_manager}" = "yes"; then
-    if test "${WEAVE_SYSTEM_CONFIG_USE_SOCKETS}" eq 0; then
+    if test ${WEAVE_SYSTEM_CONFIG_USE_SOCKETS} -eq 0; then
         AC_MSG_ERROR([Building Device Manager wrapper libraries requires selecting sockets as a target network stack])
     fi
 fi    
@@ -1701,6 +1720,51 @@ AC_MSG_RESULT(${build_device_manager})
 AM_CONDITIONAL([WEAVE_BUILD_DEVICE_MANAGER], [test "${build_device_manager}" = "yes"])
 
 
+#
+# OpenWeave Python installable package (wheel)
+# 
+
+AC_MSG_CHECKING([whether to build installable Python package for OpenWeave])
+AC_ARG_ENABLE(installable_python_package,
+    [AS_HELP_STRING([--enable-installable-python-package],[Enable building of an installable Python package (wheel) for OpenWeave @<:@default=yes@:>@.])],
+    [
+        case "${enableval}" in 
+
+        no|yes)
+            build_installable_python_package=${enableval}
+            ;;
+
+        *)
+            AC_MSG_ERROR([Invalid value ${enableval} for --enable-installable-python-package])
+            ;;
+
+        esac
+    ],
+    [
+        # By default, enable building an installable Python package iff the setuptools and wheel packages
+        # are available.
+        if test "${have_python_package_setuptools}" == "yes" -a "${have_python_package_wheel}" == "yes"; then
+            build_installable_python_package=yes
+        else
+            build_installable_python_package=no
+        fi
+    ])
+
+# Fail if requested to build an installable Python package but the setuptools and wheel packages
+# are not available
+if test "${build_installable_python_package}" = "yes"; then
+    if test "${have_python_package_setuptools}" != "yes"; then
+        AC_MSG_ERROR([The Python setuptools package must be installed in order to build an installable package for OpenWeave])
+    fi
+    if test "${have_python_package_wheel}" != "yes"; then
+        AC_MSG_ERROR([The Python wheel package must be installed in order to build an installable package for OpenWeave])
+    fi
+fi
+
+AC_MSG_RESULT(${build_installable_python_package})
+AM_CONDITIONAL([WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE], [test "${build_installable_python_package}" = "yes"])
+
+
 #
 # Verhoeff support
 #

src/device-manager/python/Makefile.am

@@ -40,6 +40,7 @@ openweave_PYTHON                                  = \
 # Location into which the "openweave" python package will be installed.
 openweavedir                                      = $(pyexecdir)/openweave
 
+
 # ------------------------------------------------------------
 # DLL wrapper for Weave Device Manager 
 # ------------------------------------------------------------
@@ -95,14 +96,49 @@ install-exec-hook:
 	rm -f $(DESTDIR)$(openweavedir)/_WeaveDeviceMgr.la
 	rm -f $(DESTDIR)$(openweavedir)/_WeaveDeviceMgr.a
 
+
 # ------------------------------------------------------------
 # Weave Device Manager Shell Script 
 # ------------------------------------------------------------
 
-dist_bin_SCRIPTS = weave-device-mgr
+EXTRA_DIST =										\
+    $(srcdir)/weave-device-mgr.py					\
+    $(NULL)
+
+bin_SCRIPTS = weave-device-mgr
 
 weave-device-mgr: $(srcdir)/weave-device-mgr.py
 	cp $(srcdir)/weave-device-mgr.py weave-device-mgr
 
+CLEANFILES = weave-device-mgr
+
+
+# ------------------------------------------------------------
+# "openweave" Python Wheel
+# ------------------------------------------------------------
+
+if WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE
+
+EXTRA_DIST +=										\
+    $(srcdir)/build-openweave-wheel.py				\
+    $(NULL)
+
+.openweave-wheel: $(srcdir)/build-openweave-wheel.py weave-device-mgr _WeaveDeviceMgr.la $(shell find $(srcdir) -type f -name '*.py')
+	rm -f openweave-*.whl
+	$(PYTHON) $(srcdir)/build-openweave-wheel.py
+	touch .openweave-wheel
+
+install-exec-local: .openweave-wheel
+	mkdir -p $(DESTDIR)$(pyexecdir)
+	rm -f $(DESTDIR)$(pyexecdir)/openweave-*.whl
+	cp openweave-*.whl $(DESTDIR)$(pyexecdir)
+
+uninstall-local:
+	rm -f $(DESTDIR)$(pyexecdir)/openweave-*.whl
+
+clean-local:
+	rm -f .openweave-wheel openweave-*.whl
+
+endif # WEAVE_BUILD_INSTALLABLE_PYTHON_PACKAGE
 
 include $(abs_top_nlbuild_autotools_dir)/automake/post.am