Superdesk REST API server
Project description
# Superdesk Server [![Build Status](https://travis-ci.org/superdesk/superdesk-server.png?branch=master)](https://travis-ci.org/superdesk/superdesk-server)
Superdesk Server provides a REST API server for [Superdesk project](https://wiki.sourcefabric.org/x/DgWX). It’s a python app, built on top of [eve](http://python-eve.org/)/[flask](http://flask.pocoo.org/) framework.
There is some basic infrastructure plus app modules for users, authentication, ingest, archive, etc.
## 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](./settings.py)).
## Installation
Using virtualenv is recommended for installing python requirements. So once activated, run:
`sh $ pip install -r requirements.txt `
### External libs
For image processing you will need some extra packages:
[image manipulation](http://pillow.readthedocs.org/en/latest/installation.html#external-libraries)
### Services
mongodb
elasticsearch
redis
## CI
Use nosetests for unit tests:
`sh $ nosetests `
Behave for behaviour testing:
`sh $ behave `
Flake8 for style check:
`sh $ flake8 `
## Running Dev Server
Use honchu to run the app - it will start api server on port 5000, websocket server on port 5100 and celery.
`sh $ honcho start `
### API Documentation
You can see API Documentation on [apiary](http://docs.superdesk.apiary.io/).
## Running cli commands
`sh $ python manage.py `
This will give you list of available commands.
### Creating admin user
This command will create an administrator user.
`sh $ python manage.py users:create -u <username> -p <password> -e <email> `
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for Superdesk-Server-0.1.5-beta.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7740a39e828d57772f7ef94e6bc24d2ed1c808027395d2ce07148c0f7a13089f |
|
MD5 | 737f2bbfc51138de1362f331265c1247 |
|
BLAKE2b-256 | 7ed8003e8b3c66d9429c3be6afdd394527ed616fe835ded7813aa007ea7e59fa |