setup.py

#!/usr/bin/env python
# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
# vi: set ft=python sts=4 ts=4 sw=4 et:
"""Nipype : Neuroimaging in Python pipelines and interfaces package.

Nipype intends to create python interfaces to other neuroimaging
packages and create an API for specifying a full analysis pipeline in
python.

Much of the machinery at the beginning of this file has been copied over from
nibabel denoted by ## START - COPIED FROM NIBABEL and a corresponding ## END

"""
# Build helper
import os
from os.path import join as pjoin

# Commit hash writing, and dependency checking
from setuptools.command.build_py import build_py


class BuildWithCommitInfoCommand(build_py):
    """Return extended build command class for recording commit

    The extended command tries to run git to find the current commit, getting
    the empty string if it fails.  It then writes the commit hash into a file
    in the `pkg_dir` path, named ``COMMIT_INFO.txt``.

    In due course this information can be used by the package after it is
    installed, to tell you what commit it was installed from if known.

    To make use of this system, you need a package with a COMMIT_INFO.txt file
    e.g. ``myproject/COMMIT_INFO.txt`` - that might well look like this::

        # This is an ini file that may contain information about the code state
        [commit hash]
        # The line below may contain a valid hash if it has been substituted
        # during 'git archive'
        archive_subst_hash=$Format:%h$
        # This line may be modified by the install process
        install_hash=

    The COMMIT_INFO file above is also designed to be used with git
    substitution - so you probably also want a ``.gitattributes`` file in the
    root directory of your working tree that contains something like this::

       myproject/COMMIT_INFO.txt export-subst

    That will cause the ``COMMIT_INFO.txt`` file to get filled in by ``git
    archive`` - useful in case someone makes such an archive - for example with
    via the github 'download source' button.

    Although all the above will work as is, you might consider having something
    like a ``get_info()`` function in your package to display the commit
    information at the terminal.  See the ``pkg_info.py`` module in the nipy
    package for an example.
    """

    def run(self):
        import subprocess
        import configparser

        build_py.run(self)
        proc = subprocess.Popen(
            "git rev-parse --short HEAD",
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            shell=True,
        )
        repo_commit = proc.communicate()[0].decode()

        # We write the installation commit even if it's empty
        cfg_parser = configparser.RawConfigParser()
        cfg_parser.read(pjoin("nipype", "COMMIT_INFO.txt"))
        cfg_parser.set("commit hash", "install_hash", repo_commit.strip())
        out_pth = pjoin(self.build_lib, "nipype", "COMMIT_INFO.txt")
        cfg_parser.write(open(out_pth, "w"))


def main():
    from setuptools import setup, find_packages

    thispath, _ = os.path.split(__file__)

    testdatafiles = [
        pjoin("testing", "data", val)
        for val in os.listdir(pjoin(thispath, "nipype", "testing", "data"))
        if not os.path.isdir(pjoin(thispath, "nipype", "testing", "data", val))
    ]

    testdatafiles += [
        pjoin("testing", "data", "dicomdir", "*"),
        pjoin("testing", "data", "bedpostxout", "*"),
        pjoin("testing", "data", "tbss_dir", "*"),
        pjoin("testing", "data", "brukerdir", "fid"),
        pjoin("testing", "data", "brukerdir", "pdata", "1", "*"),
        pjoin("testing", "data", "ds005", "*"),
        pjoin("testing", "data", "realign_json.json"),
        pjoin("workflows", "data", "*"),
        pjoin("pipeline", "engine", "report_template.html"),
        pjoin("external", "d3.js"),
        pjoin("interfaces", "fsl", "model_templates", "*"),
        pjoin("interfaces", "tests", "use_resources"),
        "pytest.ini",
        "conftest.py",
    ]

    # Python 3: use a locals dictionary
    # http://stackoverflow.com/a/1463370/6820620
    ldict = locals()
    # Get version and release info, which is all stored in nipype/info.py
    ver_file = os.path.join(thispath, "nipype", "info.py")
    with open(ver_file) as infofile:
        exec(infofile.read(), globals(), ldict)

    setup(
        name=ldict["NAME"],
        maintainer=ldict["MAINTAINER"],
        maintainer_email=ldict["MAINTAINER_EMAIL"],
        description=ldict["DESCRIPTION"],
        long_description=ldict["LONG_DESCRIPTION"],
        long_description_content_type="text/x-rst",
        url=ldict["URL"],
        download_url=ldict["DOWNLOAD_URL"],
        license=ldict["LICENSE"],
        classifiers=ldict["CLASSIFIERS"],
        author=ldict["AUTHOR"],
        author_email=ldict["AUTHOR_EMAIL"],
        platforms=ldict["PLATFORMS"],
        version=ldict["VERSION"],
        python_requires=ldict["PYTHON_REQUIRES"],
        install_requires=ldict["REQUIRES"],
        provides=ldict["PROVIDES"],
        packages=find_packages(),
        package_data={"nipype": testdatafiles},
        cmdclass={"build_py": BuildWithCommitInfoCommand},
        tests_require=ldict["TESTS_REQUIRES"],
        zip_safe=False,
        extras_require=ldict["EXTRA_REQUIRES"],
        entry_points="""
           [console_scripts]
           nipypecli=nipype.scripts.cli:cli
        """,
    )


if __name__ == "__main__":
    main()