Issue #3: Implementation of multi-platform packaging with PyInstaller (…

…#2)

* cosmetic

* First pass at multi-platform packaging

* Clarify for Windows

* Fix case

* Add eggs to ignore

* Remove IDE-specific files as per galenatjpl

.gitignore

@@ -1,3 +1,15 @@
 build/
 dist/
+eggs
 PDS_Inspect_Tool.egg-info
+*.spec
+.DS_Store
+.installed.cfg
+bin
+develop-eggs
+*.log
+parts
+*.py[co]
+typescript
+.*.swp
+*.sublime-*

README.rst

@@ -1,6 +1,6 @@
-===============================
-PDS Inspect Tool
-===============================
+===================
+ PDS Inspect Tool
+===================
 
 
 PDS Inspect Tool
@@ -20,3 +20,70 @@ following commands:
 
 The distribution can then be found in the 'dist' directory.
 
+In order to create installers compatible with certain platforms, see below.
+
+
+Platform Specific Installations
+===============================
+
+You can create installers for the PDS Inspect Tool for specific platforms.
+To do so, you will need to build the installer on the target platform. In
+other words, you can't build the Windows installer on a Linux box.
+
+
+Requirements
+------------
+
+Regardless of platform, the requirements are the same. First, install Python
+2.7 with Tkinter support. Then install PyQt4 into the Python 2.7 installation.
+Then, make a virtualenv from *that* installation, letting the virtualenv
+have access to PyQt4 by passing ``--system-site-packages``::
+
+    virtualenv --system-site-packages /tmp/mypython  (macOS, Linux, other Unix-like)
+    virtualenv.exe --system-site-packages \tmp\mypython  (Windows)
+
+(If your Python 2.7 installation didn't come with ``vitualenv``, you may have
+to install it separately.) Inside that virutalenv, install ``matplotlib``,
+``seaborn``, and PDS4_tools-1.0; on macOS, Linux, or other Unix-like systems::
+
+    cd /tmp/mypython
+    bin/pip install matplotlib seaborn
+    bin/pip install http://pdssbn.astro.umd.edu/ftp/tools/readpds_python/1.0/PDS4_tools-1.0.zip
+
+On Windows::
+
+    cd \tmp\mypython
+    Scripts\pip.exe install matplotlib seaborn
+    Scripts\pip.exe install http://pdssbn.astro.umd.edu/ftp/tools/readpds_python/1.0/PDS4_tools-1.0.zip
+
+
+Building Out
+------------
+
+Building the platform-specific installers leverages Buildout_.  The Buildout
+bootstrapper script, ``boostrap.py`` is included with the PDS Inspect Tool
+source.  Simply do the following (adjusting paths and platform-specifics as
+needed):
+
+1. Use the Python from your vitualenv to bootstrap:
+   ``/tmp/mypython/bin/python2.7 bootstrap.py``
+2. Build out: ``bin/buildout``
+
+Then run the platform-specific installation:
+
+For Windows
+    ``bin/buildout install windows``. This will create
+    ``dist/PDS-Inspect-Tool.exe`` which Windows users can double-click
+    to run.
+For macOS
+    ``bin/buildout install macos``. This will create
+    ``dist/PDS-Inspect-Tool.app`` which macOS users can double-click
+    to run.
+For Linux
+    ``bin/buildout install linux``. This will create
+    ``dist/PDS-Inspect-Tool`` which Linux users can run.
+
+
+
+
+.. _Buildout: https://buildout.org/

bootstrap.py

@@ -0,0 +1,210 @@
+##############################################################################
+#
+# Copyright (c) 2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+"""
+
+import os
+import shutil
+import sys
+import tempfile
+
+from optparse import OptionParser
+
+__version__ = '2015-07-01'
+# See zc.buildout's changelog if this version is up to date.
+
+tmpeggs = tempfile.mkdtemp(prefix='bootstrap-')
+
+usage = '''\
+[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
+
+Bootstraps a buildout-based project.
+
+Simply run this script in a directory containing a buildout.cfg, using the
+Python that you want bin/buildout to use.
+
+Note that by using --find-links to point to local resources, you can keep
+this script from going over the network.
+'''
+
+parser = OptionParser(usage=usage)
+parser.add_option("--version",
+                  action="store_true", default=False,
+                  help=("Return bootstrap.py version."))
+parser.add_option("-t", "--accept-buildout-test-releases",
+                  dest='accept_buildout_test_releases',
+                  action="store_true", default=False,
+                  help=("Normally, if you do not specify a --version, the "
+                        "bootstrap script and buildout gets the newest "
+                        "*final* versions of zc.buildout and its recipes and "
+                        "extensions for you.  If you use this flag, "
+                        "bootstrap and buildout will get the newest releases "
+                        "even if they are alphas or betas."))
+parser.add_option("-c", "--config-file",
+                  help=("Specify the path to the buildout configuration "
+                        "file to be used."))
+parser.add_option("-f", "--find-links",
+                  help=("Specify a URL to search for buildout releases"))
+parser.add_option("--allow-site-packages",
+                  action="store_true", default=False,
+                  help=("Let bootstrap.py use existing site packages"))
+parser.add_option("--buildout-version",
+                  help="Use a specific zc.buildout version")
+parser.add_option("--setuptools-version",
+                  help="Use a specific setuptools version")
+parser.add_option("--setuptools-to-dir",
+                  help=("Allow for re-use of existing directory of "
+                        "setuptools versions"))
+
+options, args = parser.parse_args()
+if options.version:
+    print("bootstrap.py version %s" % __version__)
+    sys.exit(0)
+
+
+######################################################################
+# load/install setuptools
+
+try:
+    from urllib.request import urlopen
+except ImportError:
+    from urllib2 import urlopen
+
+ez = {}
+if os.path.exists('ez_setup.py'):
+    exec(open('ez_setup.py').read(), ez)
+else:
+    exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez)
+
+if not options.allow_site_packages:
+    # ez_setup imports site, which adds site packages
+    # this will remove them from the path to ensure that incompatible versions
+    # of setuptools are not in the path
+    import site
+    # inside a virtualenv, there is no 'getsitepackages'.
+    # We can't remove these reliably
+    if hasattr(site, 'getsitepackages'):
+        for sitepackage_path in site.getsitepackages():
+            # Strip all site-packages directories from sys.path that
+            # are not sys.prefix; this is because on Windows
+            # sys.prefix is a site-package directory.
+            if sitepackage_path != sys.prefix:
+                sys.path[:] = [x for x in sys.path
+                               if sitepackage_path not in x]
+
+setup_args = dict(to_dir=tmpeggs, download_delay=0)
+
+if options.setuptools_version is not None:
+    setup_args['version'] = options.setuptools_version
+if options.setuptools_to_dir is not None:
+    setup_args['to_dir'] = options.setuptools_to_dir
+
+ez['use_setuptools'](**setup_args)
+import setuptools
+import pkg_resources
+
+# This does not (always?) update the default working set.  We will
+# do it.
+for path in sys.path:
+    if path not in pkg_resources.working_set.entries:
+        pkg_resources.working_set.add_entry(path)
+
+######################################################################
+# Install buildout
+
+ws = pkg_resources.working_set
+
+setuptools_path = ws.find(
+    pkg_resources.Requirement.parse('setuptools')).location
+
+# Fix sys.path here as easy_install.pth added before PYTHONPATH
+cmd = [sys.executable, '-c',
+       'import sys; sys.path[0:0] = [%r]; ' % setuptools_path +
+       'from setuptools.command.easy_install import main; main()',
+       '-mZqNxd', tmpeggs]
+
+find_links = os.environ.get(
+    'bootstrap-testing-find-links',
+    options.find_links or
+    ('http://downloads.buildout.org/'
+     if options.accept_buildout_test_releases else None)
+    )
+if find_links:
+    cmd.extend(['-f', find_links])
+
+requirement = 'zc.buildout'
+version = options.buildout_version
+if version is None and not options.accept_buildout_test_releases:
+    # Figure out the most recent final version of zc.buildout.
+    import setuptools.package_index
+    _final_parts = '*final-', '*final'
+
+    def _final_version(parsed_version):
+        try:
+            return not parsed_version.is_prerelease
+        except AttributeError:
+            # Older setuptools
+            for part in parsed_version:
+                if (part[:1] == '*') and (part not in _final_parts):
+                    return False
+            return True
+
+    index = setuptools.package_index.PackageIndex(
+        search_path=[setuptools_path])
+    if find_links:
+        index.add_find_links((find_links,))
+    req = pkg_resources.Requirement.parse(requirement)
+    if index.obtain(req) is not None:
+        best = []
+        bestv = None
+        for dist in index[req.project_name]:
+            distv = dist.parsed_version
+            if _final_version(distv):
+                if bestv is None or distv > bestv:
+                    best = [dist]
+                    bestv = distv
+                elif distv == bestv:
+                    best.append(dist)
+        if best:
+            best.sort()
+            version = best[-1].version
+if version:
+    requirement = '=='.join((requirement, version))
+cmd.append(requirement)
+
+import subprocess
+if subprocess.call(cmd) != 0:
+    raise Exception(
+        "Failed to execute command:\n%s" % repr(cmd)[1:-1])
+
+######################################################################
+# Import and run buildout
+
+ws.add_entry(tmpeggs)
+ws.require(requirement)
+import zc.buildout.buildout
+
+if not [a for a in args if '=' not in a]:
+    args.append('bootstrap')
+
+# if -c was provided, we push it back into args for buildout' main function
+if options.config_file is not None:
+    args[0:0] = ['-c', options.config_file]
+
+zc.buildout.buildout.main(args)
+shutil.rmtree(tmpeggs)

buildout.cfg

@@ -0,0 +1,50 @@
+[buildout]
+extensions = buildout.packagename
+parts =
+    python
+    omelette
+
+[python]
+recipe = zc.recipe.egg
+eggs =
+    ${buildout:package-name}
+    pyinstaller
+interpreter = python
+initialization = import os; os.environ['MPLBACKEND'] = 'Qt4Agg'
+
+
+[omelette]
+recipe = collective.recipe.omelette
+eggs = ${python:eggs}
+
+
+[pyinstaller]
+options = --noconfirm --runtime-hook=${buildout:directory}/pyinstaller-hook.py
+options-unix = ${:options} --add-data 'pds_inspect_tool/Icons:Icons' --add-data 'pds_inspect_tool/templates:templates' --add-data 'pds_inspect_tool/styleSheets:styleSheets'
+options-windows = ${:options} --add-data pds_inspect_tool\Icons;Icons --add-data pds_inspect_tool\templates;templates --add-data pds_inspect_tool\styleSheets;styleSheets
+
+[macos]
+recipe = collective.recipe.cmd
+on_install = true
+cmds =
+    ${buildout:bin-directory}/pyinstaller \
+        ${pyinstaller:options-unix} \
+        --windowed \
+        --osx-bundle-identifier "gov.nasa.jpl.pds.apps.PDS-Inspect-Tool" \
+        ${buildout:bin-directory}/${buildout:package-name}    
+
+[windows]
+# On Windows, the "cmds" must be a single command and all on a single line
+recipe = collective.recipe.cmd
+on_install = true
+cmds = ${buildout:bin-directory}/pyinstaller ${pyinstaller:options-windows} --onefile --windowed --version-file "${buildout:directory}/etc/version-info.txt" --name "${buildout:package-name}" "${buildout:bin-directory}/${buildout:package-name}-script.py"
+
+[linux]
+recipe = collective.recipe.cmd
+on_install = true
+cmds =
+    ${buildout:bin-directory}/pyinstaller \
+        ${pyinstaller:options-unix} \
+        --windowed \
+        --onefile \
+        ${buildout:bin-directory}/${buildout:package-name}