This is one of the components in the Citizen Desk project
Interface stands for Application Programming Interface, that is API. The role of this component is to expose the entities in the database, and the [core][core] functionalities, through an authenticated API. Once exposed, they can be used by a web or mobile frontend, see for example the web [Citizen Desk frontend][frontend].
This project depends on [Superdesk Server][superdesk_server] which
does not specifies all its dependencies, so dependency handling has to
be handled with special care, through the superdesk-dependencies.txt
file. Currently not all the Superdesk dependencies are added there,
but just those that show to be necessary for the used modules.
Eve 0.5-dev is used by Superdesk. Citizen Desk also depends directly on Eve 0.5, because it included a fix to a problem with documents embedding in lists
Like [Eve][eve], this component is a [Flask][flask] application, and
therefore a WSGI application. You can refer to the deploying section
in the Flask doc in
order to have more info about running and deploying the
app. Specifically i used Gunicorn in order to serve the app, and you
may find a few simple scripts i used in this repository root. The
scripts have the dot extension because they can be run using `source