setup.py

#!/usr/bin/env python
# File created on 17 Feb 2010
from __future__ import division

import re
import sys
from setuptools import setup
from stat import S_IEXEC
from os import (chdir, getcwd, listdir, chmod, walk, rename, remove, chmod,
                stat, devnull, environ)
from os.path import join, abspath
from subprocess import call, Popen, PIPE
from glob import glob
from urllib import FancyURLopener
from tempfile import mkdtemp
from shutil import rmtree, copy

__author__ = "QIIME development team"
__copyright__ = "Copyright (c) 2011--, %s" % __author__
__credits__ = ["Greg Caporaso", "Kyle Bittinger", "Jai Ram Rideout",
               "Yoshiki Vazquez Baeza", "Jose Antonio Navas Molina"]
__license__ = "GPL"
__version__ = "1.9.1-dev"
__maintainer__ = "Greg Caporaso"
__email__ = "qiime.help@gmail.com"


long_description = """QIIME: Quantitative Insights Into Microbial Ecology
http://www.qiime.org

QIIME Allows Integration and Analysis of High-Throughput Community Sequencing Data
J. Gregory Caporaso, Justin Kuczynski, Jesse Stombaugh, Kyle Bittinger, Frederic D. Bushman, Elizabeth K. Costello, Noah Fierer, Antonio Gonzalez Pena, Julia K. Goodrich, Jeffrey I. Gordon, Gavin A. Huttley, Scott T. Kelley, Dan Knights, Jeremy E. Koenig, Ruth E. Ley, Cathy A. Lozupone, Daniel McDonald, Brian D. Muegge, Meg Pirrung, Jens Reeder, Joel R. Sevinsky, Peter J. Turnbaugh, William van Treuren, William A. Walters, Jeremy Widmann, Tanya Yatsunenko, Jesse Zaneveld and Rob Knight.
Nature Methods, 2010.
"""

# heavily based on lib.util.download_file from github.com/qiime/qiime-deploy
class URLOpener(FancyURLopener):
    def http_error_default(self, url, fp, errcode, errmsg, headers):
        raise IOError(
            'Could not download %s\nPlease ensure the URL is valid and that '
            'you have an active Internet connection.' % url)

# heavily based on lib.util.download_file from github.com/qiime/qiime-deploy
def download_file(URL, dest_dir, local_file, num_retries=4):
    """General file downloader

    Inputs:
    URL: string to download the file from
    dest_dir: directory where you want to download the file
    local_file: output filename of the download
    num_retries: number of times the function will try to download the file

    Output:
    return_code: exit status for the download 0 = success, 1 = fail
    """
    status('  Downloading %s...' % local_file)

    url_opener = URLOpener()
    localFP = join(dest_dir, local_file)
    tmpDownloadFP = '%s.part' % localFP

    return_code = 1
    while num_retries > 0:
        try:
            tmpLocalFP, headers = url_opener.retrieve(URL, tmpDownloadFP)
            rename(tmpDownloadFP, localFP)
            return_code = 0
        except IOError as msg:
            if num_retries == 1:
                status('  Download of %s failed.' % URL)
            else:
                status('  Download failed. Trying again... %d tries remain.' %
                       (num_retries - 1))
            num_retries -= 1
        else:
            num_retries = 0
            status('  %s downloaded successfully.' % local_file)
    return return_code


def app_available(app_name):
    """Check if a binary is available and on the user Path

    Inputs:
    app_name: Name of the binary, i. e. 'ls', 'gcc' etc.

    Output:
    False if the binary is not found, True if the binary is found
    """
    # redirect all output to /dev/null so nothing is seen on screen
    devnull_fd = open(devnull, 'w')
    output = True

    try:
        call([app_name], stdout=devnull_fd, stderr=devnull_fd)
    except OSError:
        output = False
    finally:
        devnull_fd.close()

    return output


def system_call(cmd, error_msg):
    """Call `cmd` and return whether it was successful or not.

    This function is taken and modified from qcli (previously
    `qcli_system_call`).

    """
    proc = Popen(cmd,
                 shell=True,
                 universal_newlines=True,
                 stdout=PIPE,
                 stderr=PIPE)
    # communicate pulls all stdout/stderr from the PIPEs to
    # avoid blocking -- don't remove this line!
    stdout, stderr = proc.communicate()
    return_value = proc.returncode

    success = return_value == 0
    if not success:
        status("Unable to %s:" % error_msg)
        status("  stdout:")
        for line in stdout.split('\n'):
            status("    " + line)
        status("  stderr:")
        for line in stderr.split('\n'):
            status("    " + line)
    return success


def catch_install_errors(install_function, name):
    try:
        install_function()
    except (KeyboardInterrupt, SystemExit):
        raise
    except:
        exception_type, exception_value = sys.exc_info()[:2]
        status(
            "Skipping installation of %s due to failure while downloading, "
            "building, or installing:\n  %s: %s\n" %
            (name, exception_type.__name__, exception_value))


def status(msg):
    """Write message immediately to stdout."""
    sys.stdout.write(msg)
    sys.stdout.write('\n')
    sys.stdout.flush()


def build_denoiser():
    """ Build the denoiser code binary """
    status("Building denoiser...")

    if not app_available('ghc'):
        status("GHC not installed, so cannot build the denoiser binary "
               "'FlowgramAli_4frame'.\n")
        return

    cwd = getcwd()
    denoiser_dir = join(cwd, 'qiime/support_files/denoiser/FlowgramAlignment')

    try:
        chdir(denoiser_dir)

        if not system_call('make clean', 'clean denoiser build directory'):
            return

        if not system_call('make', 'build denoiser'):
            return

        status("Denoiser built.\n")
    finally:
        chdir(cwd)


def download_UCLUST():
    """Download the UCLUST executable and set it to the scripts directory"""
    status("Installing UCLUST...")

    if sys.platform == 'darwin':
        URL = 'http://www.drive5.com/uclust/uclustq1.2.22_i86darwin64'
    elif sys.platform == 'linux2':
        URL = 'http://www.drive5.com/uclust/uclustq1.2.22_i86linux64'
    else:
        status("Platform %r not supported by UCLUST.\n" % sys.platform)
        return

    return_value = download_file(URL, 'scripts/', 'uclust')

    # make the file an executable file
    if not return_value:
        chmod('scripts/uclust', stat('scripts/uclust').st_mode | S_IEXEC)
        status("UCLUST installed.\n")
    else:
        status("UCLUST could not be installed.\n")


def build_FastTree():
    """Download and build FastTree then copy it to the scripts directory"""
    status("Building FastTree...")

    if not app_available('gcc'):
        status("GCC not installed, so cannot build FastTree.\n")
        return

    if download_file('http://www.microbesonline.org/fasttree/FastTree-2.1.3.c',
                     'scripts/', 'FastTree.c'):
        status("Could not download FastTree, so not installing it.\n")
        return

    cwd = getcwd()
    scripts = join(cwd, 'scripts')

    try:
        chdir(scripts)

        # as suggested by the docs in FastTree.c
        if not system_call(
            'gcc -Wall -O3 -finline-functions -funroll-loops -o FastTree '
            'FastTree.c -lm',
            'build FastTree'):
            return

        status("FastTree built.\n")
    finally:
        # remove the source
        remove('FastTree.c')
        chdir(cwd)


def build_SortMeRNA():
    """Download and build SortMeRNA then copy it to the scripts directory"""
    status("Building SortMeRNA...")

    # SortMeRNA's configure script doesn't correctly guess the C/C++ compilers
    # to use on OS X. Try to figure that out here.
    if sys.platform.lower() in ['darwin', 'macos']:
        cxx = 'clang++'
        cc = 'clang'
    elif sys.platform.lower() in ['linux', 'linux2']:
        cxx = 'g++'
        cc = 'gcc'
    else:
        status("Unknown or unsupported platform %r, so cannot build SortMeRNA.\n" % sys.platform)
        return

    for compiler in cxx, cc:
        if not app_available(compiler):
            status("%r not installed, so cannot build SortMeRNA.\n" % compiler)
            return

    cwd = getcwd()
    scripts = join(cwd, 'scripts')
    cxx_old = environ.get('CXX', '')
    cc_old = environ.get('CC', '')

    try:
        tempdir = mkdtemp()
        if download_file('ftp://ftp.microbio.me/pub/sortmerna-2.0-no-db.tar.gz',
                         tempdir, 'sortmerna-2.0-no-db.tar.gz'):
            status("Could not download SortMeRNA, so cannot install it.\n")
            return

        chdir(tempdir)

        if not system_call('tar xzf sortmerna-2.0-no-db.tar.gz',
                           'extract SortMeRNA archive'):
            return

        chdir('sortmerna-2.0')

        environ['CXX'] = cxx
        environ['CC'] = cc

        if not system_call('bash build.sh', 'build SortMeRNA'):
            return

        copy('sortmerna', scripts)
        copy('indexdb_rna', scripts)
        status("SortMeRNA built.\n")
    finally:
        environ['CXX'] = cxx_old
        environ['CC'] = cc_old

        # remove the source
        rmtree(tempdir)
        chdir(cwd)


def build_SUMACLUST():
    """Download and build SUMACLUST then copy it to the scripts directory"""
    status("Building SUMACLUST...")

    cwd = getcwd()
    scripts = join(cwd, 'scripts')

    try:
        tempdir = mkdtemp()
        if download_file('ftp://ftp.microbio.me/pub/QIIME-v1.9.0-dependencies/suma_package_V_1.0.00.tar.gz',
                         tempdir, 'suma_package_V_1.0.00.tar.gz'):
            status("Could not download SUMACLUST, so cannot install it.\n")
            return

        chdir(tempdir)

        if not system_call('tar xzf suma_package_V_1.0.00.tar.gz',
                           'extract SUMACLUST archive'):
            return

        chdir('suma_package_V_1.0.00/sumaclust')

        if not system_call('make', 'build SUMACLUST'):
            return

        copy('sumaclust', scripts)
        status("SUMACLUST built.\n")
    finally:
        # remove the source
        rmtree(tempdir)
        chdir(cwd)


def build_swarm():
    """Download and build swarm then copy it to the scripts directory"""
    status("Building swarm...")

    cwd = getcwd()
    scripts = join(cwd, 'scripts')

    try:
        tempdir = mkdtemp()
        if download_file('https://github.com/torognes/swarm/archive/1.2.19.tar.gz',
                         tempdir, 'swarm-1.2.19.tar.gz'):
            status("Could not download swarm, so cannot install it.\n")
            return

        chdir(tempdir)

        if not system_call('tar xzf swarm-1.2.19.tar.gz',
                           'extract swarm archive'):
            return

        chdir('swarm-1.2.19')

        if not system_call('make', 'build swarm'):
            return

        copy('swarm', scripts)
        copy('scripts/amplicon_contingency_table.py', scripts)
        copy('scripts/swarm_breaker.py', scripts)
        status("swarm built.\n")
    finally:
        # remove the source
        rmtree(tempdir)
        chdir(cwd)


# don't build any of the non-Python dependencies if the following modes are
# invoked
if all([e not in sys.argv for e in 'egg_info', 'sdist', 'register']):
    catch_install_errors(build_denoiser, 'denoiser')
    catch_install_errors(download_UCLUST, 'UCLUST')
    catch_install_errors(build_FastTree, 'FastTree')
    catch_install_errors(build_SortMeRNA, 'SortMeRNA')
    catch_install_errors(build_SUMACLUST, 'SUMACLUST')
    catch_install_errors(build_swarm, 'swarm')

classes = """
    Development Status :: 5 - Production/Stable
    Environment :: Console
    License :: OSI Approved :: GNU General Public License v2 (GPLv2)
    Topic :: Scientific/Engineering :: Bio-Informatics
    Programming Language :: Python
    Programming Language :: Python :: 2.7
    Operating System :: Unix
    Operating System :: MacOS :: MacOS X
    Operating System :: POSIX
"""
classifiers = [s.strip() for s in classes.split('\n') if s]

# compile the list of all qiime_test_data files that need to be installed.
# these must be relative file paths, beginning after the qiime_test_data
# directory
qiime_test_data_files = []
for root, dnames, fnames in walk('qiime_test_data'):
    try:
        # strip 'qiime_test_data/' from the beginning of root
        root = root.split('/', 1)[1]
    except IndexError:
        # if there is no '/', then we're in qiime_test_data itself
        # so there is nothing to do
        continue
    else:
        # if there is a slash, we're in a script test data directory,
        # so compile all relative filepaths
        for fname in fnames:
            qiime_test_data_files.append(join(root, fname))

setup(name='qiime',
      version=__version__,
      description='Quantitative Insights Into Microbial Ecology',
      long_description=long_description,
      author=__author__,
      classifiers=classifiers,
      author_email=__email__,
      maintainer=__author__,
      maintainer_email=__email__,
      url='http://www.qiime.org',
      packages=['qiime', 'qiime/parallel', 'qiime/pycogent_backports',
                'qiime/denoiser', 'qiime/workflow', 'qiime_test_data'],
      scripts=glob('scripts/*py') + glob('scripts/FlowgramAli_4frame') +
      glob('scripts/FastTree') + glob('scripts/uclust') +
      glob('scripts/indexdb_rna') + glob('scripts/sortmerna') +
      glob('scripts/sumaclust') + glob('scripts/swarm'),
      package_data={'qiime':
                    ['support_files/qiime_config',
                     'support_files/css/*css',
                     'support_files/html_templates/*html',
                     'support_files/images/*png',
                     'support_files/js/*js',
                     'support_files/R/*r',
                     'support_files/denoiser/Data/*',
                     'support_files/denoiser/TestData/*',
                     'support_files/denoiser/FlowgramAlignment/*.lhs',
                     'support_files/denoiser/FlowgramAlignment/Makefile'],
                    'qiime_test_data': qiime_test_data_files},
      license=__license__,
      keywords=['bioinformatics', 'microbiome', 'microbiology', 'qiime'],
      platforms=['MacOS', 'Linux'],
      install_requires=['numpy >= 1.9.0',
                        'scipy >= 0.14.0',
                        'cogent == 1.5.3',
                        'natsort < 4.0.0',
                        'matplotlib >= 1.1.0, != 1.4.2',
                        'pynast == 1.2.2', 'qcli >= 0.1.1, < 0.2.0', 'gdata',
                        'biom-format >= 2.1.4, < 2.2.0',
                        'emperor >= 0.9.51, < 1.0.0',
                        'scikit-bio >= 0.2.3, < 0.3.0',
                        'burrito-fillings >= 0.1.1, < 0.2.0',
                        'pandas >= 0.13.1', 'burrito >= 0.9.1, < 1.0.0',
                        'qiime-default-reference >= 0.1.2, < 0.2.0'],
      extras_require={'all': ['ipython[notebook] >= 3.1.0, < 4.0.0',
                              'sphinx >= 0.3']}
      )