Metadata-Version: 2.0
Name: Cohorte-Herald
Version: 0.0.2
Summary: An easy-to-use messaging framework
Home-page: https://github.com/isandlaTech/cohorte-herald
Author: Thomas Calmant
Author-email: thomas.calmant@isandlatech.com
License: Apache License 2.0
Download-URL: https://github.com/isandlaTech/cohorte-herald/archive/master.zip
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: iPOPO (>=0.5.7)
Requires-Dist: sleekxmpp (>=1.3.1)
Requires-Dist: requests (>=2.3.0)

Cohorte Herald for Python
*************************

Herald is an easy-to-use messaging framework.
It allows Pelix/iPOPO and Java OSGi frameworks to communicate with each other
using messages, without worrying about the underlying protocol used for
transmission.


Concepts
========

Each Pelix framework instance is considered as a *peer*.
A peer has a unique ID and a human-readable name.
An application ID is associated to each peer: only peers with the same
application ID can discover each other.

A peer can send a message to another peer or to a group of peers.
A message has a subject, which listeners register to, and a content.


Remote Services
===============

Herald provides an RPC transport implementations for Pelix Remote Services.


Transports
==========

Currently, Herald supports two protocols in Python, and one in Java:

* HTTP (Python & Java):

  * Each message is sent as a POST request.
  * Peer discovery is based on a home-made multicast heart beat protocol
  * Best transport for LAN applications and for single-peer messages
  * Implementation is based on `requests <http://docs.python-requests.org/>`_.

* XMPP (Python only, for now):

  * Each message is a either a message or a group message
  * Discovery is based on a Multi-User Chat room (XEP-0045)
  * Best transport for distributed applications and for group messages
  * Implementation is based on `SleekXMPP <http://sleekxmpp.com/>`_


License
=======

Cohorte Herald is released under the terms of the Apache Software License 2.0.


