Metadata-Version: 1.1
Name: kinto-megaphone
Version: 0.2.0
Summary: Send global broadcast messages to Megaphone on changes
Home-page: https://github.com/glasserc/kinto_megaphone
Author: Ethan Glasser-Camp
Author-email: eglassercamp@mozilla.com
License: Apache License (2.0)
Description: kinto-megaphone
        ===============
        
        |travis| |master-coverage|
        
        .. |travis| image:: https://travis-ci.org/glasserc/kinto-megaphone.svg?branch=master
            :target: https://travis-ci.org/glasserc/kinto-megaphone
        
        .. |master-coverage| image::
            https://coveralls.io/repos/glasserc/kinto-megaphone/badge.png?branch=master
            :alt: Coverage
            :target: https://coveralls.io/r/glasserc/kinto-megaphone
        
        Send global broadcast messages to Megaphone on changes.
        
        * `Megaphone <https://github.com/mozilla-services/megaphone/>`_
        * `Kinto documentation <http://kinto.readthedocs.io/en/latest/>`_
        * `Issue tracker <https://github.com/glasserc/kinto-megaphone/issues>`_
        
        
        Installation
        ------------
        
        Install the Python package:
        
        ::
        
            pip install kinto-megaphone
        
        
        Add it to kinto.includes::
        
            kinto.includes = kinto_megaphone
        
        Then, you'll want to add a listener.
        
        The kinto-megaphone listener is called CollectionTimestampListener and
        it notifies megaphone with the new collection timestamp every time it
        changes. If talking to megaphone fails, it will abort the request (including
        rollback the changes made in the request).
        
        kinto-megaphone only offers this one kind of listener right
        now, but that could change later.
        
        Add it using configuration like::
        
          kinto.event_listeners = mp
          kinto.event_listeners.mp.use = kinto_megaphone.listeners
        
        Every listener also needs the following settings (with real values)::
        
          kinto.event_listeners.mp.api_key = foobar
          kinto.event_listeners.mp.url = http://megaphone.example.com/
          kinto.event_listeners.mp.broadcaster_id = remote-settings
        
        
        Changelog
        =========
        
        This document describes changes between each past release.
        
        
        0.2.0 (2018-09-25)
        ------------------
        
        - Update to match kinto 10.1.1 -- see Kinto/kinto#1770 (#2).
        - Add a heartbeat feature.
        
        
        0.1.0 (2018-09-12)
        ------------------
        
        - Initial implementation
        
        
        Contributors
        ============
        
        * Ethan Glasser-Camp <eglassercamp@mozilla.com>
        
Keywords: kinto plugin
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: License :: OSI Approved :: Apache Software License
