3.1. datanator_rest_api package

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)[source]

Bases: cement.ext.ext_argparse.ArgparseController

Base controller for command line application

class Meta[source]

Bases: object

arguments = [(['-v', '--version'], {'action': 'version', 'version': '0.0.2'})][source]
description = 'datanator_rest_api'[source]
label = 'base'[source]
cmd1()[source]

command_1 description

cmd2()[source]

command_2 description

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

Bases: cement.core.foundation.App

Command line application

class Meta[source]

Bases: object

base_controller = 'base'[source]
handlers = [<class 'datanator_rest_api.__main__.BaseController'>, <class 'datanator_rest_api.__main__.Command3WithArgumentsController'>][source]
label = 'datanator_rest_api'[source]
class datanator_rest_api.__main__.Command3WithArgumentsController(*args, **kw)[source]

Bases: cement.ext.ext_argparse.ArgparseController

Command3 description

class Meta[source]

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'})][source]
description = 'Command3 description'[source]
label = 'command-3'[source]
stacked_on = 'base'[source]
stacked_type = 'nested'[source]
datanator_rest_api.__main__.main()[source]

3.1.4. 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, config_class=<class 'datanator_query_python.config.config.FlaskProfiler'>)[source]

3.1.5. Module contents