setup.py

#!/usr/bin/env python
"""
ARTview - the ARM Radar Toolkit Viewer.

ARTview, is an open source Python module that
allows access to Py-ART functions within a PyQt graphical interface and
provides visualization of weather radar data.

"""

import os
import shutil
import sys
import re
import subprocess
import glob

if sys.version_info[0] < 3:
    import __builtin__ as builtins
else:
    import builtins

DOCLINES = __doc__.split("\n")

CLASSIFIERS = """\
Development Status :: 3 - Alpha
Intended Audience :: Science/Research
Intended Audience :: Developers
License :: OSI Approved :: BSD License
Programming Language :: Python
Programming Language :: Python :: 2
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3
Programming Language :: Python :: 3.3
Programming Language :: Python :: 3.4
Programming Language :: Python :: 3.5
Topic :: Scientific/Engineering
Topic :: Scientific/Engineering :: Atmospheric Science
Operating System :: POSIX :: Linux
Operating System :: MacOS :: MacOS X
Operating System :: Microsoft :: Windows
"""

NAME = 'ARTview'
MAINTAINER = "ARTview Developers"
MAINTAINER_EMAIL = "nguysur@gmail.com"
DESCRIPTION = DOCLINES[0]
LONG_DESCRIPTION = "\n".join(DOCLINES[2:])
URL = "https://github.com/nguy/artview"
DOWNLOAD_URL = "https://github.com/nguy/artview"
LICENSE = 'BSD'
CLASSIFIERS = filter(None, CLASSIFIERS.split('\n'))
PLATFORMS = ["Linux", "Mac OS-X", "Unix"]
MAJOR = 1
MINOR = 3
MICRO = 7
ISRELEASED = True
ISPROFILING = False
VERSION = '%d.%d.%d' % (MAJOR, MINOR, MICRO)
SCRIPTS = glob.glob('scripts/*') + ['scripts/artview']


# Return the git revision as a string
def git_version():
    def _minimal_ext_cmd(cmd):
        # construct minimal environment
        env = {}
        for k in ['SYSTEMROOT', 'PATH']:
            v = os.environ.get(k)
            if v is not None:
                env[k] = v
        # LANGUAGE is used on win32
        env['LANGUAGE'] = 'C'
        env['LANG'] = 'C'
        env['LC_ALL'] = 'C'
        out = subprocess.Popen(
            cmd, stdout=subprocess.PIPE, env=env).communicate()[0]
        return out

    try:
        out = _minimal_ext_cmd(['git', 'rev-parse', 'HEAD'])
        GIT_REVISION = out.strip().decode('ascii')
    except OSError:
        GIT_REVISION = "Unknown"

    return GIT_REVISION

# BEFORE importing distutils, remove MANIFEST. distutils doesn't properly
# update it when the contents of directories change.
if os.path.exists('MANIFEST'):
    os.remove('MANIFEST')

# This is a bit hackish: we are setting a global variable so that the main
# artview __init__ can detect if it is being loaded by the setup routine, to
# avoid attempting to load components that aren't built yet. While ugly, it's
# a lot more robust than what was previously being used.
builtins.__ARTVIEW_SETUP__ = True


def write_version_py(filename='artview/version.py'):
    cnt = """
# THIS FILE IS GENERATED FROM ARTVIEW SETUP.PY
short_version = '%(version)s'
version = '%(version)s'
full_version = '%(full_version)s'
git_revision = '%(git_revision)s'
release = %(isrelease)s
profiling = %(isprofiling)s

if not release:
    version = full_version
"""
    # Adding the git rev number needs to be done inside write_version_py(),
    # otherwise import of artview.version messes up the build under Python 3.
    FULLVERSION = VERSION
    if os.path.exists('.git'):
        GIT_REVISION = git_version()
    elif os.path.exists('artview/version.py'):
        # must be a source distribution, use existing version file
        try:
            from artview.version import git_revision as GIT_REVISION
        except ImportError:
            raise ImportError("Unable to import git_revision. Try removing "
                              "artview/version.py and the build directory "
                              "before building.")
    else:
        GIT_REVISION = "Unknown"

    if not ISRELEASED:
        FULLVERSION += '.dev+' + GIT_REVISION[:7]

    a = open(filename, 'w')
    try:
        a.write(cnt % {'version': VERSION,
                       'full_version': FULLVERSION,
                       'git_revision': GIT_REVISION,
                       'isrelease': str(ISRELEASED),
                       'isprofiling': str(ISPROFILING)})
    finally:
        a.close()


def configuration(parent_package='', top_path=None):
    from numpy.distutils.misc_util import Configuration
    config = Configuration(None, parent_package, top_path)
    config.set_options(ignore_setup_xxx_py=True,
                       assume_default_configuration=True,
                       delegate_options_to_subpackages=True,
                       quiet=True)

    config.add_subpackage('artview')
    config.add_data_files(('artview', '*.txt'))

    return config


def setup_package():

    # rewrite version file
    write_version_py()

    try:
        from numpy.distutils.core import setup
    except:
        from distutils.core import setup

    setup(
        name=NAME,
        maintainer=MAINTAINER,
        maintainer_email=MAINTAINER_EMAIL,
        description=DESCRIPTION,
        long_description=LONG_DESCRIPTION,
        url=URL,
        version=VERSION,
        download_url=DOWNLOAD_URL,
        license=LICENSE,
        classifiers=CLASSIFIERS,
        platforms=PLATFORMS,
        configuration=configuration,
        scripts=SCRIPTS,
    )


def pre_instalation_tests():
    # make tests before installing
    # to avoid risking breaking instalation do it in a try
    try:
        from tests.qt import test_matplotlib_qt_backend
        ans = test_matplotlib_qt_backend()
        if ans is False:
            exit(-1)
    except:
        pass

    # test dependencies
    from pkg_resources import parse_version
    dependencies = {
        'pyart': '1.6',
        'matplotlib': '1.1.0',
        # 'mpl_toolkits.basemap': '0.99',
        }
    for key in dependencies.keys():
        dep = __import__(key, locals(), globals(), ['__name__'])
        if dependencies[key] is not None:
            if (parse_version(dep.__version__) <
                parse_version(dependencies[key])):
                raise Exception('Missing Dependency: %s >= %s. Has %s, %s' %
                                (key, dependencies[key], key, dep.__version__))

    # test pyqt4 (non standard version)
    try:
        from PyQt4.Qt import PYQT_VERSION_STR
        if (parse_version(PYQT_VERSION_STR) <
            parse_version('4.6')):
            raise Exception('Missing Dependency: %s >= %s. Has %s, %s' %
                            ('PyQt4', '4.6', 'PyQt4', PYQT_VERSION_STR))
    except ImportError:
        try:
            from PyQt5.Qt import PYQT_VERSION_STR
        except ImportError:
            raise Exception('Missing Dependency: PyQt')

if __name__ == '__main__':
    pre_instalation_tests()
    setup_package()