Live Blog Server
Live Blog Server provides a REST API server for Live Blog project. It's a python app, built on top of eve/flask framework.
Some basic infrastructure and apps(authentication, users, archive, notifications, activity, preferences) are used from Superdesk project. The application is focused implementing the Live Blog custom apps like blog management, blog posts and ingest from different sources.
Requirements
We support python version 3.3+.
Other requirements are mongodb server and elasticsearch instance. Both can be configured via environment variables (see settings.py).
Installation
Using virtualenv is recommended for installing python requirements. So once activated, run:
$ pip install -r requirements.txt
External libs
For image processing you will need some extra packages:
Services
- mongodb
- elasticsearch
CI
Use nosetests for unit tests:
$ nosetests
Behave for behaviour testing:
$ behave
Flake8 for style check:
$ flake8
Running Dev Server
Use honchu to run the app - it will start api server on port 5001
and websocket server on port 5101
.
$ honcho start
API Documentation
You can see API Documentation on apiary.
Running cli commands
$ python manage.py
This will give you list of available commands.
Creating admin user
This command will create an administrator user.
$ python manage.py users:create -u <username> -p <password> -e <email>