sdk/python/setup.py

   1 #!/usr/bin/env python3
   2 # Copyright (C) The Arvados Authors. All rights reserved.
   3 #
   4 # SPDX-License-Identifier: Apache-2.0
   5
   6 from __future__ import absolute_import
   7 import distutils.command.build
   8 import os
   9 import setuptools
  10 import sys
  11 import re
  12
  13 from pathlib import Path
  14 from setuptools import setup, find_packages
  15
  16 SETUP_DIR = os.path.dirname(__file__) or '.'
  17 README = os.path.join(SETUP_DIR, 'README.rst')
  18
  19 import arvados_version
  20 version = arvados_version.get_version(SETUP_DIR, "arvados")
  21
  22 short_tests_only = False
  23 if '--short-tests-only' in sys.argv:
  24     short_tests_only = True
  25     sys.argv.remove('--short-tests-only')
  26
  27 class BuildDiscoveryPydoc(setuptools.Command):
  28     """Run discovery2pydoc as part of the build process
  29
  30     This class implements a setuptools subcommand, so it follows
  31     [the SubCommand protocol][1]. Most of these methods are required by that
  32     protocol, except `should_run`, which we register as the subcommand
  33     predicate.
  34
  35     [1]: https://setuptools.pypa.io/en/latest/userguide/extension.html#setuptools.command.build.SubCommand
  36     """
  37     DEFAULT_JSON_PATH = Path(SETUP_DIR, '..', '..', 'doc', 'arvados-v1-discovery.json')
  38     DEFAULT_OUTPUT_PATH = Path('arvados', 'api_resources.py')
  39     NAME = 'discovery2pydoc'
  40     description = "build skeleton Python from the Arvados discovery document"
  41     editable_mode = False
  42     user_options = [
  43         ('discovery-json=', 'J', 'JSON discovery document used to build pydoc'),
  44         ('discovery-output=', 'O', 'relative path to write discovery document pydoc'),
  45     ]
  46
  47     def initialize_options(self):
  48         self.build_lib = None
  49         self.discovery_json = None
  50         self.discovery_output = str(self.DEFAULT_OUTPUT_PATH)
  51
  52     def finalize_options(self):
  53         # Set self.build_lib to match whatever the build_py subcommand uses.
  54         self.set_undefined_options('build_py', ('build_lib', 'build_lib'))
  55         if self.discovery_json is None and self.DEFAULT_JSON_PATH.exists():
  56             self.discovery_json = str(self.DEFAULT_JSON_PATH)
  57         out_path = Path(self.discovery_output)
  58         if out_path.is_absolute():
  59             raise Exception("--discovery-output should be a relative path")
  60         else:
  61             self.out_path = Path(self.build_lib, out_path)
  62
  63     def run(self):
  64         import discovery2pydoc
  65         self.mkpath(str(self.out_path.parent))
  66         arglist = ['--output-file', str(self.out_path)]
  67         if self.discovery_json is None:
  68             print(
  69                 "warning: trying to load a live discovery document from configuration",
  70                 file=sys.stderr,
  71             )
  72         else:
  73             arglist.append(self.discovery_json)
  74         returncode = discovery2pydoc.main(arglist)
  75         if returncode != 0:
  76             raise Exception(f"discovery2pydoc exited {returncode}")
  77
  78     def should_run(self):
  79         return True
  80
  81     # The protocol docs say that get_outputs should list *all* outputs, while
  82     # get_output_mapping maps get_source_files to output file paths. Since we
  83     # are generating files from outside the source tree, we should just return
  84     # our output, with the source file list and output mapping both empty.
  85     def get_outputs(self):
  86         return [str(self.out_path)]
  87
  88     def get_source_files(self):
  89         return []
  90
  91     def get_output_mapping(self):
  92         return {}
  93 # Run discovery2pydoc as the first subcommand of build.
  94 distutils.command.build.build.sub_commands.insert(
  95     0, (BuildDiscoveryPydoc.NAME, BuildDiscoveryPydoc.should_run),
  96 )
  97
  98 setup(name='arvados-python-client',
  99       version=version,
 100       description='Arvados client library',
 101       long_description=open(README).read(),
 102       author='Arvados',
 103       author_email='info@arvados.org',
 104       url="https://arvados.org",
 105       download_url="https://github.com/arvados/arvados.git",
 106       license='Apache 2.0',
 107       cmdclass={
 108           BuildDiscoveryPydoc.NAME: BuildDiscoveryPydoc,
 109       },
 110       packages=find_packages(),
 111       scripts=[
 112           'bin/arv-copy',
 113           'bin/arv-get',
 114           'bin/arv-keepdocker',
 115           'bin/arv-ls',
 116           'bin/arv-migrate-docker19',
 117           'bin/arv-federation-migrate',
 118           'bin/arv-normalize',
 119           'bin/arv-put',
 120           'bin/arv-ws'
 121       ],
 122       data_files=[
 123           ('share/doc/arvados-python-client', ['LICENSE-2.0.txt', 'README.rst']),
 124       ],
 125       install_requires=[
 126           'ciso8601 >=2.0.0',
 127           'future',
 128           'google-api-core <2.11.0', # 2.11.0rc1 is incompatible with google-auth<2
 129           'google-api-python-client >=2.1.0',
 130           'google-auth<2',
 131           'httplib2 >=0.9.2, <0.20.2',
 132           'pycurl >=7.19.5.1, <7.45.0',
 133           'ruamel.yaml >=0.15.54, <0.17.22',
 134           'setuptools',
 135           'ws4py >=0.4.2',
 136           'protobuf<4.0.0dev',
 137           'pyparsing<3',
 138           'setuptools>=40.3.0',
 139       ],
 140       classifiers=[
 141           'Programming Language :: Python :: 3',
 142       ],
 143       test_suite='tests',
 144       tests_require=['pbr<1.7.0', 'mock>=1.0,<4', 'PyYAML', 'parameterized'],
 145       zip_safe=False
 146       )