Applications Reference

sams.apps.api: API App

The SAMS API Application

This application provides an API to manage, produce and/or consume SAMS.

get_app(import_name: Optional[str] = 'sams.apps.api', config: Optional[Dict[str, Any]] = None) → sams.factory.app.SamsApp

Creates and returns a new instance of the SAMS API application

Default integrated apps:

CORE_APPS = [
    'sams.sets',
    'sams.storage',
    'sams.assets',
    'sams.commands'
]

INSTALLED_APPS = [
    'sams.factory.sentry',
    'sams.api.admin',
    'sams.api.consume',
    'sams.api.produce'
]

Parameters

• import_name (str) – Optional name to use for this application (defaults to __package__)

• config (dict) – Optional config overrides

Returns

SAMS API application instance

Return type

sams.factory.app.SamsApp

sams.apps.file_server: FileServer App

The SAMS File Server Application

This application that serves public files using a web server.

get_app(import_name: Optional[str] = 'sams.apps.file_server', config: Optional[Dict[str, Any]] = None) → sams.factory.app.SamsApp

Creates and returns a new instance of the SAMS FileServer application

Default integrated apps:

CORE_APPS = [
    'sams.sets',
    'sams.storage',
    'sams.assets'
]

INSTALLED_APPS = [
    'sams.factory.sentry',
    'sams.api.public'
]

Parameters

• import_name (str) – Optional name to use for this application (defaults to __package__)

• config (dict) – Optional config overrides

Returns

SAMS API application instance

Return type

sams.factory.app.SamsApp