Metadata-Version: 2.1
Name: Relay-python
Version: 0.0.7
Summary: A Python client for the relay service which relays server-side messages to client-side subscribers (e.g. browser) via websockets.
Home-page: https://github.com/GetmeUK/relay-python
Author: Anthony Blackshaw
Author-email: ant@getme.co.uk
Maintainer: Anthony Blackshaw
Maintainer-email: ant@getme.co.uk
License: MIT
Description: # Relay Python Library
        
        A Python client for the relay service which relays server-side messages to client-side subscribers (e.g. browser) via websockets.
        
        
        ## Installation
        
        ```
        pip install relay-python
        ```
        
        ## Requirements
        
        - Python 3.7+
        
        
        # Usage
        
        ```Python
        
        import relay
        
        client = relay.Client('your_api_key...')
        
        # Publish a message to subscribers over the nav channel
        client.publish(
            ['global'],
            {
                'action': 'nav_update',
                'payload': {
                    'inbox_unread': 2
                }
            }
        )
        
        # Close a subscriber with the user Id burt
        client.close('burt')
        
        ```
        
Keywords: api relay
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Database
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
