setup.py

"""setuptools-based installation script.

File is based on this template: https://github.com/pypa/sampleproject
"""

import os
import unittest
# Always prefer setuptools over distutils
from setuptools import find_packages
from setuptools import setup


# Note that this pinning policy covers the Python libraries dsub itself runs
# with; it deliberately does not extend to the cloud-sdk container image the
# Google providers run their auxiliary steps in. Pinning that image is actively
# harmful, because gcr.io deletes numbered tags after a year and every release
# pinning one then breaks. See CLOUD_SDK_IMAGE in dsub/providers/google_utils.py
# for that tradeoff and for DSUB_CLOUD_SDK_IMAGE, which lets an operator pin the
# image locally when a cloud-sdk release regresses them.
_DEPENDENCIES = [
    # dependencies for dsub, ddel, dstat
    # Pin to known working versions to prevent episodic breakage from library
    # version mismatches.
    # This version list generated: 09/03/2025
    # direct dependencies
    'google-api-python-client>=2.47.0,<=2.181.0',
    'google-auth>=2.6.6,<=2.40.3',
    'google-cloud-batch>=0.17.36',
    'python-dateutil<=2.9.0',
    'pytz<=2025.2',
    'pyyaml<=6.0.1',
    'tenacity<=8.2.3',
    'tabulate<=0.9.0',
    # downstream dependencies
    'funcsigs==1.0.2',
    'google-api-core>=2.7.3,<=2.25.1',
    'google-auth-httplib2<=0.2.0',
    'httplib2<=0.22.0',
    'protobuf>=3.19.0,<=6.32.0',
    'pyasn1<=0.6.0',
    'pyasn1-modules<=0.4.0',
    'rsa<=4.9',
    'uritemplate<=4.1.1',
    # dependencies for test code
    'parameterized<=0.9.0',
    'mock<=5.1.0',
]


def unittest_suite():
  """Get test suite (Python unit tests only)."""
  test_loader = unittest.TestLoader()
  test_suite = test_loader.discover('test/unit', pattern='test_*.py')
  return test_suite


def get_dsub_version():
  """Get the dsub version out of the _dsub_version.py source file.

  Setup.py should not import dsub version from dsub directly since ambiguity in
  import order could lead to an old version of dsub setting the version number.
  Parsing the file directly is simpler than using import tools (whose interface
  varies between python 2.7, 3.4, and 3.5).

  Returns:
    string of dsub version.

  Raises:
    ValueError: if the version is not found.
  """
  filename = os.path.join(os.path.dirname(__file__), 'dsub/_dsub_version.py')
  with open(filename, 'r') as versionfile:
    for line in versionfile:
      if line.startswith('DSUB_VERSION ='):
        # Get the version then strip whitespace and quote characters.
        version = line.partition('=')[2]
        return version.strip().strip('\'"')
  raise ValueError('Could not find version.')


def get_readme_contents():
  """Get the README.md contents."""
  with open('README.md', 'r') as f:
    return f.read()


setup(
    name='dsub',

    # Python 2 is no longer supported. Use Python 3.
    python_requires='>=3.7',

    # Versions should comply with PEP440.
    version=get_dsub_version(),
    description=('A command-line tool that makes it easy to submit and run'
                 ' batch scripts in the cloud'),
    long_description=get_readme_contents(),
    long_description_content_type='text/markdown',

    # The project's main homepage.
    url='https://github.com/DataBiosphere/dsub',

    # Author details
    author='Verily',
    # Choose your license
    license='Apache',
    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
    classifiers=[
        # How mature is this project? Common values are
        #   3 - Alpha
        #   4 - Beta
        #   5 - Production/Stable
        'Development Status :: 4 - Beta',

        # Indicate who your project is intended for
        'Intended Audience :: Developers',
        'Topic :: Scientific/Engineering :: Bio-Informatics',
        'Topic :: Scientific/Engineering :: Information Analysis',
        'Topic :: System :: Distributed Computing',

        # Pick your license as you wish (should match "license" above)
        'License :: OSI Approved :: Apache Software License',

        # Specify the Python versions you support here. In particular, ensure
        # that you indicate whether you support Python 2, Python 3 or both.
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
        'Programming Language :: Python :: 3.10',
    ],

    # What does your project relate to?
    keywords='cloud bioinformatics',

    # Packages to distribute.
    packages=find_packages(),
    include_package_data=True,

    # List run-time dependencies here.  These will be installed by pip when
    # your project is installed.
    install_requires=_DEPENDENCIES,

    # Define a test suite for Python unittests only.
    test_suite='setup.unittest_suite',

    # Provide executable scripts - these will be added to the user's path.
    entry_points={
        'console_scripts': [
            'dsub=dsub.commands.dsub:main',
            'dstat=dsub.commands.dstat:main',
            'ddel=dsub.commands.ddel:main',
        ],
    },
)