Metadata-Version: 1.1
Name: janus-gateway
Version: 0.1.0
Summary: Python client for Janus.
Home-page: https://github.com/mayfieldrobotics/janus-py/
Author: Mayfield Robotics
Author-email: dev+janus-py@mayfieldrobotics.com
License: BSD
Description: =====
        janus
        =====
        
        Python client for `janus <https://github.com/meetecho/janus-gateway>`_.
        
        dev
        ---
        
        Setup a `venv <https://virtualenvwrapper.readthedocs.org/en/latest/>`_:
        
        .. code:: json
        
           $ mkvirtualenv janus
           (janus)$ pip install -e .[test]
        
        and test it:
        
        .. code:: bash
        
           (janus)$ py.test test/ --cov janus --cov-report term-missing --pep8
        
        usage
        -----
        
        Typical usage is to create a representation of your Janus `Plugin`:
        
        .. code:: python
        
            class MyPlugin(janus.Plugin):
        
                name = 'janus.plugin.krazyeyezkilla'
        
                def sup(self, greets)
                    self.send_message({'wat': greets})
        
        
            my_plugin = MyPlugin()
        
        setup a `Session`:
        
        .. code:: python
        
            session = janus.Session('ws://127.0.0.1', secret='janusrocks')
            session.register_plugin(my_plugin)
        
        keep it alive:
        
        .. code:: python
        
            session_ka = janus.KeepAlive(session)
            session_ka.daemon = True
            session_ka.start()
        
        and then use your plugin:
        
        .. code:: python
        
            my_plugin.sup('dawg')
        
Platform: any
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
