Refer to component plugins rather than package plugins throughout.

Author: philthompson10

doc/sysroot.rst

@@ -31,14 +31,14 @@ develop a plugin for a commonly used component then please consider
 contributing it so that it can be included in a future release of
 :program:`pyqtdeploy`.
 
-TODO - building a spec file from scratch
-
 
 Standard Component Plugins
 --------------------------
 
 TODO - describe what comes as standard
 
+TODO - building a spec file from scratch
+
 
 The :program:`pyqt-demo` Sysroot
 --------------------------------
@@ -55,29 +55,29 @@ The full set of command line options is:
 
     This will display a summary of the command line options.
 
+.. option:: --component COMPONENT
+
+    ``COMPONENT`` is the name of the component (specified in the JSON file)
+    that will be built.  It may be used more than once to build multiple
+    components.  If the option is not specified then all components specified
+    in the JSON file will be built.
+
 .. option:: --no-clean
 
     A temporary build directory (called ``build`` in the sysroot) is created in
-    order to build the required packages.  Normally this is removed
-    automatically after all packages have been built.  Specifying this option
-    leaves the build directory as it is to make debugging package plugins
+    order to build the required components.  Normally this is removed
+    automatically after all components have been built.  Specifying this option
+    leaves the build directory as it is to make debugging component plugins
     easier.
 
 .. option:: --options
 
-    This causes the configurable options of each package specified in the JSON
-    file to be displayed on ``stdout``.  The program will then terminate.
-
-.. option:: --package PACKAGE
-
-    ``PACKAGE`` is the name of the package (specified in the JSON file) that
-    will be built.  It may be used more than once to build multiple packages.
-    If the option is not specified then all packages specified in the JSON file
-    will be built.
+    This causes the configurable options of each component specified in the
+    JSON file to be displayed on ``stdout``.  The program will then terminate.
 
 .. option:: --plugin-dir DIR
 
-    ``DIR`` is added to the list of directories that are searched for package
+    ``DIR`` is added to the list of directories that are searched for component
     plugins.  It may be used more than once to search multiple directories.
     All directories specified in this way will be searched before those
     directories (internal to :program:`pyqtdeploy-sysroot`) searched by
@@ -86,14 +86,14 @@ The full set of command line options is:
 .. option:: --source-dir DIR
 
     ``DIR`` is the name of the directory containing the source archives used to
-    build the packages specified in the JSON file.
+    build the components specified in the JSON file.
 
 .. option:: --sysroot DIR
 
     ``DIR`` is the name of the system root directory.  The default value is
     ``sysroot-`` followed by a target-specific suffix.  Unless the
-    :option:`--package` option is specified any existing sysroot will first be
-    removed and re-created.
+    :option:`--component` option is specified any existing sysroot will first
+    be removed and re-created.
 
 .. option:: --target TARGET
 
@@ -113,10 +113,11 @@ The full set of command line options is:
     This specifies that the version number should be displayed on ``stdout``.
     The program will then terminate.
 
-.. option:: json
+.. option:: specification
 
-    ``json`` is the name of a JSON specification file that defines each package
-    to be included in the sysroot and how each is to be configured.
+    ``specification`` is the name of a JSON specification file that defines
+    each component to be included in the sysroot and how each is to be
+    configured.
 
 
 Writing A Component Plugin

pyqtdeploy/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017, Riverbank Computing Limited
+# Copyright (c) 2018, Riverbank Computing Limited
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -33,5 +33,5 @@
 from .version import PYQTDEPLOY_RELEASE
 
 
-# These are for the package plugins.
-from .sysroot import AbstractPackage, PackageOption
+# These are for the component plugins.
+from .sysroot import AbstractComponent, ComponentOption

pyqtdeploy/pyqtdeploysysroot_main.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017, Riverbank Computing Limited
+# Copyright (c) 2018, Riverbank Computing Limited
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -38,16 +38,16 @@ def main():
     # Parse the command line.
     parser = argparse.ArgumentParser()
 
+    parser.add_argument('--component', help="the component name to build",
+            action='append')
     parser.add_argument('--no-clean',
             help="do not remove the temporary build directory",
             action='store_true')
     parser.add_argument('--options',
-            help="show the options available for the packages",
+            help="show the options available for the components",
             action='store_true')
-    parser.add_argument('--package', help="the package name to build",
-            action='append')
     parser.add_argument('--plugin-dir',
-            help="search a directory for package plugins", metavar="DIR",
+            help="search a directory for component plugins", metavar="DIR",
             action='append')
     parser.add_argument('--source-dir',
             help="the default directory containing the source archives",
@@ -61,7 +61,7 @@ def main():
             action='store_true')
     parser.add_argument('-V', '--version', action='version',
             version=PYQTDEPLOY_RELEASE)
-    parser.add_argument('json',
+    parser.add_argument('specification',
             help="JSON specification of the system image root directory")
 
     args = parser.parse_args()
@@ -74,13 +74,13 @@ def main():
         if not sysroot_dir:
             sysroot_dir = os.environ.get('SYSROOT')
 
-        sysroot = Sysroot(sysroot_dir, args.json, args.plugin_path,
+        sysroot = Sysroot(sysroot_dir, args.specification, args.plugin_path,
                 args.source_dir, args.target, message_handler)
 
         if args.options:
-            sysroot.show_options(args.package)
+            sysroot.show_options(args.component)
         else:
-            sysroot.build_packages(args.package, args.no_clean)
+            sysroot.build_components(args.component, args.no_clean)
     except UserException as e:
         message_handler.exception(e)
         return 1

pyqtdeploy/sysroot/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017, Riverbank Computing Limited
+# Copyright (c) 2018, Riverbank Computing Limited
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -24,6 +24,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 
-# Publish the sub-package's API.
-from .abstract_package import AbstractPackage, PackageOption
+# Publish the component API.
+from .abstract_component import AbstractComponent, ComponentOption
 from .sysroot import Sysroot

pyqtdeploy/sysroot/abstract_package.py renamed to pyqtdeploy/sysroot/abstract_component.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017, Riverbank Computing Limited
+# Copyright (c) 2018, Riverbank Computing Limited
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -27,8 +27,8 @@
 from abc import ABC, abstractmethod
 
 
-class PackageOption:
-    """ Encapsulate an option for the package in the specification file. """
+class ComponentOption:
+    """ Encapsulate an option for the component in the specification file. """
 
     def __init__(self, name, type, required=False, default=None, values=None, help=None):
         """ Initialise the object. """
@@ -59,17 +59,17 @@ def _format_value(self, value):
         return value
 
 
-class AbstractPackage(ABC):
-    """ The base class for the implementation of a package plugin. """
+class AbstractComponent(ABC):
+    """ The base class for the implementation of a component plugin. """
 
-    # A sequence of PackageOption instances describing the options that can be
-    # specified for the package in the specification file.  These are made
+    # A sequence of ComponentOption instances describing the options that can
+    # be specified for the component in the specification file.  These are made
     # available as attributes of the plugin instance.
     options = []
 
     @abstractmethod
     def build(self, sysroot, debug):
-        """ Build the package. """
+        """ Build the component. """
 
     def configure(self, sysroot):
-        """ Complete the configuration of the package. """
+        """ Complete the configuration of the component. """

pyqtdeploy/sysroot/packages/__init__.py renamed to pyqtdeploy/sysroot/plugins/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017, Riverbank Computing Limited
+# Copyright (c) 2018, Riverbank Computing Limited
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -28,17 +28,17 @@
 import os
 import sys
 
-from ... import AbstractPackage, PackageOption
+from ... import AbstractComponent, ComponentOption
 
 
-class OpenSSLPackage(AbstractPackage):
-    """ The OpenSSL package. """
+class OpenSSLComponent(AbstractComponent):
+    """ The OpenSSL component. """
 
-    # The package-specific options.
+    # The component options.
     options = [
-        PackageOption('python_source', str,
+        ComponentOption('python_source', str,
                 help="The archive of the Python source code containing patches to build OpenSSL on macOS."),
-        PackageOption('source', str, required=True,
+        ComponentOption('source', str, required=True,
                 help="The archive containing the OpenSSL source code."),
     ]
 
@@ -51,7 +51,7 @@ def build(self, sysroot):
         archive = sysroot.find_file(self.source)
         sysroot.unpack_archive(archive)
 
-        # We require OpenSSL v1.0.* as Qt does.
+        # We require OpenSSL v1.0.* as Python does.
         major = minor = None
         name = os.path.basename(os.getcwd())
         name_parts = name.split('-')

pyqtdeploy/sysroot/packages/contrib/__init__.py renamed to pyqtdeploy/sysroot/plugins/contrib/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017, Riverbank Computing Limited
+# Copyright (c) 2018, Riverbank Computing Limited
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -24,15 +24,15 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 
-from ... import AbstractPackage, PackageOption
+from ... import AbstractComponent, ComponentOption
 
 
-class pipPackage(AbstractPackage):
-    """ The pip meta-package. """
+class pipComponent(AbstractComponent):
+    """ The pip meta-component. """
 
-    # The package-specific options.
+    # The component options.
     options = [
-        PackageOption('packages', list, required=True,
+        ComponentOption('packages', list, required=True,
                 help="The packages to be installed by pip."),
     ]
 

pyqtdeploy/sysroot/packages/openssl.py renamed to pyqtdeploy/sysroot/plugins/openssl.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017, Riverbank Computing Limited
+# Copyright (c) 2018, Riverbank Computing Limited
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -26,15 +26,15 @@
 
 import os
 
-from ... import AbstractPackage, PackageOption
+from ... import AbstractComponent, ComponentOption
 
 
-class PyQt3DPackage(AbstractPackage):
-    """ The PyQt3D package. """
+class PyQt3DComponent(AbstractComponent):
+    """ The PyQt3D component. """
 
-    # The package-specific options.
+    # The component options.
     options = [
-        PackageOption('source', str, required=True,
+        ComponentOption('source', str, required=True,
                 help="The archive containing the PyQt3D source code."),
     ]
 
@@ -60,7 +60,7 @@ def build(self, sysroot):
                 sysroot.target_sip_dir,
                 os.path.join(sysroot.target_sitepackages_dir, 'PyQt5'))
 
-        disabled_features = sysroot.find_package('pyqt5').disabled_features
+        disabled_features = sysroot.find_component('pyqt5').disabled_features
         if disabled_features:
             cfg += 'pyqt_disabled_features = {0}\n'.format(
                     ' '.join(disabled_features))