downtoearth package

Submodules

downtoearth.cli module

downtoearth creates terraform files from api configuration definitions.

downtoearth.cli.parse_args()

Parse arguments.

downtoearth.cli.main()

Build template and output to file.

downtoearth.default module

Define defaults used in downtoearth.

downtoearth.exceptions module

Exceptions for downtoearth.

These are helpers provided so that you can raise proper HTTP code errors from your API.

Usage:

from downtoearth.exceptions import NotFoundException raise NotFoundException(‘your princess is in another castle’)

exception downtoearth.exceptions.BadRequestException(msg)

Bases: exceptions.Exception

exception downtoearth.exceptions.ConflictException(msg)

Bases: exceptions.Exception

exception downtoearth.exceptions.InternalServerErrorException(msg)

Bases: exceptions.Exception

exception downtoearth.exceptions.NotFoundException(msg)

Bases: exceptions.Exception

exception downtoearth.exceptions.NotImplementedException(msg)

Bases: exceptions.Exception

downtoearth.model module

downtoearth API model.

class downtoearth.model.ApiModel(args)

Bases: object

downtoearth data model.

get_endpoints()

Get all paths that contain methods.

get_api_template_variables()

Get API template variables.

render_terraform()

Return a rendered terraform template.

run_stage_deployments()

run_terraform()

Return a apply terraform after template rendered.

class downtoearth.model.UrlTree

Bases: object

process_url(url, methods)

traverse_tree(node, depth=0)

get_endpoints()

class downtoearth.model.UrlNode(url, methods=None, parent=None)

Bases: object

prefix

url_name

full_url

get_endpoint_info(api_name)

append_methods(methods)

add_child(url, methods=None)

is_leaf()

is_root()

get_child(value)

has_child(value)

is_variable()

downtoearth.router module

Router helper for API’s using downtoearth.

class downtoearth.router.Router(route_map=None, param_order=None)

Bases: object

Routing object for given route_map.

Parameters:

• route_map (optional[dict]) –

  map of route to delegate ex.

  map = {

  “GET:/v1/book”: get_all, “POST:/v1/book”: post_book, “GET:/v1/book/{isbn}”: get_book, “PUT:/v1/book/{isbn}”: update_book, “DELETE:/v1/book/{isbn}”: remove_book

  }

• param_order (optional[list]) – order of precedence for parameters This should include all three parameter types. ex. [‘path’, ‘querystring’, ‘body’] defaults to [‘path’, ‘body’, ‘querystring’]

DEFAULTS = {'param_order': ['path', 'body', 'querystring']}

add_full_route(route, delegate)

Add route given route and delegate function.

Parameters:

• route (str) – route in format “VERB:route/{variables}”
• delegate (func) – function to call

add_route(verb, path, delegate)

Add route given verb, path, delegate function.

Parameters:

• verb (str) – HTTP verb ex. GET, POST
• path (str) – path
• delegate (func) – function to call

route_request(event, context)

Route incoming request.

downtoearth.test module

downtoearth.version module

Package version will be written by setup.py.

Module contents