Superdesk Server provides a REST API server for Superdesk project. It's a python app, built on top of eve/flask framework.

There is some basic infrastructure plus app modules for users, authentication, ingest, archive, etc.

We support python version 3.3+.

Other requirements are mongodb server and elasticsearch instance. Both can be configured via environment variables (see settings.py).

Using virtualenv is recommended for installing python requirements. So once activated, run:

$ pip install -r requirements.txt

For image processing you will need some extra packages:

• image manipulation

• mongodb
• elasticsearch
• redis

Use nosetests for unit tests:

$ nosetests

Behave for behaviour testing:

$ behave

Flake8 for style check:

$ flake8

Use honchu to run the app - it will start api server on port 5000, websocket server on port 5100 and celery.

$ honcho start

You can see API Documentation on apiary.

$ python manage.py

This will give you list of available commands.

This command will create an administrator user.

$ python manage.py users:create -u <username> -p <password> -e <email>