Metadata-Version: 1.0
Name: python-hall
Version: 0.1.0
Summary: A Python wrapper for the hall.com API
Home-page: https://github.com/phalt/python-hall
Author: Paul Hallett
Author-email: hello@phalt.co
License: BSD
Description: ===============================
        python-hall
        ===============================
        
        .. image:: https://badge.fury.io/py/python-hall.png
            :target: http://badge.fury.io/py/python-hall
        
        .. image:: https://travis-ci.org/phalt/python-hall.png?branch=master
                :target: https://travis-ci.org/phalt/python-hall
        
        .. image:: https://pypip.in/d/python-hall/badge.png
                :target: https://crate.io/packages/python-hall?version=latest
        
        
        A Python wrapper for the hall.com API
        
        * Free software: BSD license
        * Documentation: http://python-hall.rtfd.org.
        
        
        About
        -----
        
        Do you use `Hall.com <http://hall.com>`_ and have noticed they have a bunch of cool integrations?
        
        Wouldn't it be cool if you could build your own? Now you can!
        
        Python-hall makes it super easy to send custom messages to a Hall room.
        
        Usage
        -----
        
        Get your room keys by visiting https://hall.com/docs/integrations/generic/
        
        Note: you must be an administrator on the room in order to get access keys.
        
        Install with pip:
        
        .. code-block:: bash
        
            $ pip install python_hall
        
        Actual usage is super-simple:
        
        .. code-block:: python
        
            >>> from python_hall import Hall
            >>> h = Hall(room_token='MY_ROOM_KEY')
            >>> # An image is optional
            >>> h.image = 'http://i.imgur.com/eV6p3Wy.jpg'
            >>> # Send messages in one line!
            >>> h.send(title='dogehall', message='wow, such simple. Much Python.')
            True # Returns True is successful
        
        Result:
        
        .. image:: http://i.imgur.com/CM1UVgk.png
        
        
        Use cases
        ---------
        
        Alert your team about a new user on a site!
        
        Know about the latest dogecoin transaction as soon as it happens!
        
        Send your friends on an open hall room random jokes!
        
        
        
        
        History
        -------
        
        0.1.0 (2014-01-16)
        ++++++++++++++++++
        
        * First release on PyPI.
Keywords: python-hall
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
