setup.py

#   This Python module is part of the PyRate software package.
#
#   Copyright 2022 Geoscience Australia
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
from setuptools import setup
from setuptools.command.test import test as TestCommand
from setuptools.command.install import install
from setuptools.command.develop import develop
from subprocess import check_output, run
import platform
import setuptools
__version__ = "0.6.1"

# Get requirements (and dev requirements for testing) from requirements
#  txt files. Also ensure we are using correct GDAL version.
with open('requirements.txt') as f:
    requirements_lines = f.read().splitlines()
with open('requirements-test.txt') as f:
    test_requirements = f.read().splitlines()
with open('requirements-dev.txt') as f:
    dev_requirements = f.read().splitlines()

if platform.system() in 'Windows':
    GDAL_VERSION = check_output(["gdalinfo", "--version"]).decode(encoding="utf-8").strip().split(" ")[1][:-1]
else:
    GDAL_VERSION = check_output(["gdal-config", "--version"]).decode(encoding="utf-8").split('\n')[0]

requirements = []
for r in requirements_lines:
    if r.startswith('GDAL'):
        requirements.append('GDAL' + '=={GDAL_VERSION}'.format(GDAL_VERSION=GDAL_VERSION))
    elif r.startswith('mpi4py'):
        if run(args=['which', 'mpirun']).returncode == 0:
            requirements.append(r)
    else:
        requirements.append(r)


def update_reqs_based_on_envs(reqs):
    with open('requirements.txt', 'w') as f:
        for r in reqs:
            f.write('{}\n'.format(r))


update_reqs_based_on_envs(requirements)

setup_requirements = [r for r in requirements if "numpy==" in r]


class CustomInstall(install):
    def run(self):
        self.install_setup_requirements()
        # numpy becomes available after this line. Test it
        import numpy
        print(numpy.__version__)
        self.install_requirements()
        super().run()
        # run(args=['git', 'checkout', 'HEAD', '--', 'requirements.txt'])

    @staticmethod
    def install_setup_requirements():
        for s in setup_requirements:
            print(f'installing {s}')
            run(args=['pip', 'install', s])

    @staticmethod
    def install_requirements():
        for s in requirements:
            print(f'installing {s}')
            run(args=['pip', 'install', s])

#
#
# class CustomDevelop(develop, InstallDevelopMixin):
#     "mod of install"


class PyTest(TestCommand, object):

    def initialize_options(self):
        super(PyTest, self).initialize_options()
        self.pytest_args = []

    def finalize_options(self):
        super(PyTest, self).finalize_options()
        self.test_suite = True
        self.test_args = []

    def run_tests(self):
        # import here, cause outside the eggs aren't loaded
        import pytest
        exit(pytest.main(self.pytest_args))


readme = open('README.rst').read()
doclink = """
Documentation
-------------

The full documentation is at http://geoscienceaustralia.github.io/PyRate/"""
history = open('docs/history.rst').read().replace('.. :changelog:', '')

setup(
    name='Py-Rate',
    version=__version__,
    license="Apache Software License 2.0",
    description='A Python tool for estimating velocity and cumulative displacement '
                'time-series from Interferometric Synthetic Aperture Radar (InSAR) data.',
    long_description=readme + '\n\n' + doclink + '\n\n' + history,
    author='Geoscience Australia InSAR team',
    author_email='insar@ga.gov.au',
    url='https://github.com/GeoscienceAustralia/PyRate',
    download_url='https://github.com/GeoscienceAustralia/PyRate/archive/'+__version__+'.tar.gz',
    packages=setuptools.find_packages(),
    package_dir={'PyRate': 'pyrate'},
    package_data={
        'utils': ['colourmap.txt']
    },
    scripts=[
        'scripts/gdal_calc_local.py',
        'scripts/plot_ifgs.py',
        ],
    entry_points={
          'console_scripts': [
              'pyrate = pyrate.main:main',
              'plot_ifgs = scripts.plot_ifgs:main',
          ]
      },
    setup_requires=setup_requirements,
    install_requires=requirements,
    extras_require={
        'dev': dev_requirements
    },
    tests_require=test_requirements,
    zip_safe=False,
    keywords='PyRate, Python, InSAR, Geodesy, Remote Sensing, Image Processing',
    classifiers=[
        'Development Status :: 4 - Beta',
        "Operating System :: POSIX",
        "License :: OSI Approved :: Apache Software License",
        "Natural Language :: English",
        "Programming Language :: Python",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Intended Audience :: Science/Research",
        "Intended Audience :: Developers",
        "Topic :: Software Development :: Libraries :: Python Modules",
        "Topic :: Scientific/Engineering :: Information Analysis"
    ],
    cmdclass={
        'test': PyTest,
        'install': CustomInstall,
        # 'develop': CustomDevelop,
    }
)