.. image:: https://travis-ci.org/alexandrainst/ckanext-realtime.png?branch=master
:target: https://travis-ci.org/alexandrainst/ckanext-realtime
.. image:: https://coveralls.io/repos/alexandrainst/ckanext-realtime/badge.png
:target: https://coveralls.io/r/alexandrainst/ckanext-realtime
ckanext-realtime
ckanext-realtime is CKAN plugin which makes your CKAN site into a Realtime Data Portal. By using CkanRT.js library, client applications
can subscribe to realtime events from Observable Datastores. Check out our demo app here <http://gatesense.com/realtime/examples/ex2/>_.
For more info read the docs <http://alexandrainst.github.io/ckanext-realtime/>_. Feel free to submit your ideas and pull requests if you would like to contribute.
Copying and License
This material is copyright (c) 2014 Alexandra Instituttet A/S <http://www.alexandra.dk/uk/pages/default.aspx>_ and Gatesense <http://www.gatesense.com>_.
It is open and licensed under the GNU Affero General Public License (AGPL) v3.0
whose full text may be found at:
http://www.fsf.org/licensing/licenses/agpl-3.0.html
Quick Start Guide
What’s in the project?
. CKAN extension which enables observable datastores
. Datastore listener script (bin/datastore_listener)
. WebSocket server (bin/ckan_wss)
. JavaScript library for communication with the realtime CKAN (client/CkanRT.js)
Environment
The project has been tested on Arch Linux and Ubuntu 12.04 servers. That Said, you will need:
. Redis Server
. CKAN (tested on 2.2 but it should work with earlier minor releases as well).
. ckanext-datastore plugin enabled
Installation
. Install the plugin
| *$ python setup.py develop*
. Install the requirements
| *$ pip install -r requirements.txt*
. Set ckanext-realtime specific configuration options in your ckan config (e.g. /etc/ckan/default/production.ini):
| *# c