API Docs

Flask application factories

Flask application factories for Invenio flavours.

invenio_app.factory.app_class()[source]

Determine Flask application class.

Invenio-Files-REST needs to patch the Werkzeug form parsing in order to support streaming large file uploads. This is done by subclassing the Flask application class.

invenio_app.factory.config_loader(app, **kwargs_config)[source]

Configuration loader.

Adds support for loading templates from the Flask application’s instance folder (<instance_folder>/templates).

invenio_app.factory.create_api(**kwargs)

Flask application factory for Invenio REST API.

invenio_app.factory.create_app(**kwargs)

Flask application factory for combined UI + REST API.

REST API is mounted under /api.

invenio_app.factory.create_ui(**kwargs)

Flask application factory for Invenio UI.

invenio_app.factory.instance_path = '/home/docs/checkouts/readthedocs.org/user_builds/invenio-app/envs/latest/var/instance'

Instance path for Invenio.

Defaults to <env_prefix>_INSTANCE_PATH or if environment variable is not set <sys.prefix>/var/instance.

invenio_app.factory.static_folder = '/home/docs/checkouts/readthedocs.org/user_builds/invenio-app/envs/latest/var/instance/static'

Static folder path.

Defaults to <env_prefix>_STATIC_FOLDER or if environment variable is not set <sys.prefix>/var/instance/static.

WSGI applications

UI + REST WSGI application for Invenio flavours.

invenio_app.wsgi.application = <Flask 'invenio'>

Combined UI + REST Flask application.

REST API is mounted under /api.

REST-only WSGI application for Invenio flavours.

invenio_app.wsgi_rest.application = <Flask 'invenio'>

WSGI application for Invenio REST API.

UI-only WSGI application for Invenio flavours.

invenio_app.wsgi_ui.application = <Flask 'invenio'>

WSGI application for Invenio UI.

Celery application factory

Celery application for Invenio flavours.

invenio_app.celery.celery = <Celery default:0x7f3a2c7c3d50>

Celery application for Invenio.

Overrides SENTRY_TRANSPORT wih synchronous HTTP transport since Celery does not deal nicely with the default threaded transport.

CLI application factory

CLI application for Invenio flavours.

invenio_app.cli.cli = <flask.cli.FlaskGroup object>

Invenio CLI application.