3.1. datanator_rest_api package

3.1.1. Subpackages

• datanator_rest_api.routes package
  • Submodules
  • datanator_rest_api.routes.ftx module
  • datanator_rest_api.routes.kegg module
  • datanator_rest_api.routes.metabolites module
  • datanator_rest_api.routes.proteins module
  • datanator_rest_api.routes.reactions module
  • datanator_rest_api.routes.rna module
  • datanator_rest_api.routes.status module
  • datanator_rest_api.routes.taxon module
  • Module contents
• datanator_rest_api.server package
  • Submodules
  • datanator_rest_api.server.AutoResolver module
  • Module contents
• datanator_rest_api.spec package
  • Submodules
  • datanator_rest_api.spec.SpecUtils module
  • Module contents
• datanator_rest_api.util package
  • Submodules
  • datanator_rest_api.util.paginator module
  • datanator_rest_api.util.taxon_distance module
  • Module contents

3.1.2. Submodules

3.1.3. datanator_rest_api.__main__ module

datanator_rest_api command line interface

Author

Bilal Shaikh < bilalshaikh42@gmail.com >

Date

2019-08-20

Copyright

2019, Karr Lab

License

MIT

class datanator_rest_api.__main__.BaseController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Base controller for command line application

class Meta

Bases: object

arguments = [(['-v', '--version'], {'action': 'version', 'version': '0.0.4'})]

description = 'datanator_rest_api'

label = 'base'

cmd1()

command_1 description

cmd2()

command_2 description

class datanator_rest_api.__main__.Cli(label=None, **kw)

Bases: cement.core.foundation.App

Command line application

class Meta

Bases: object

base_controller = 'base'

handlers = [<class 'datanator_rest_api.__main__.BaseController'>, <class 'datanator_rest_api.__main__.Command3WithArgumentsController'>]

label = 'datanator_rest_api'

class datanator_rest_api.__main__.Command3WithArgumentsController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Command3 description

class Meta

Bases: object

arguments = [(['arg_1'], {'type': <class 'str'>, 'help': 'Description of arg_1'}), (['arg_2'], {'type': <class 'str'>, 'help': 'Description of arg_2'}), (['--opt-arg-3'], {'type': <class 'str'>, 'default': 'default value of opt-arg-1', 'help': 'Description of opt-arg-3'}), (['--opt-arg-4'], {'type': <class 'float'>, 'default': nan, 'help': 'Description of opt-arg-4'})]

description = 'Command3 description'

label = 'command-3'

stacked_on = 'base'

stacked_type = 'nested'

datanator_rest_api.__main__.main()

3.1.4. datanator_rest_api._version module

3.1.5. datanator_rest_api.core module

API Server Provides an automatic implementation of the rest api using the connexion library :Author: Bilal Shaikh < bilalshaikh42@gmail.com > :Date: 2019-08-19 :Copyright: 2019, Karr Lab :License: MIT

datanator_rest_api.core.create_app(apiName='DatanatorAPI.yaml', entryModule='datanator_rest_api.routes', specification_dir='./spec', resolver=<class 'datanator_rest_api.server.AutoResolver.AutoResolver'>, validate_responses=False)

3.1.6. Module contents