Metadata-Version: 2.1
Name: rocket-python
Version: 1.2.8
Summary: RocketChat API with Python
Home-page: http://github.com/dstegelman/rocket-python
Author: Derek Stegelman
Author-email: UNKNOWN
License: MIT
Keywords: rocketchat
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: requests (<3.0,>=2.0.0)

#### RocketChat API

Python API wrapper for the [Rocket chat API](https://rocket.chat/docs/developer-guides/rest-api)

[Documentation](http://rocket-python.readthedocs.io/en/latest/)

#### Install

    pip install rocket-python

#### Usage

Initialize the client with a username and password.  This user *must* have Admin privs::

    from rocketchat.api import RocketChatAPI

    api = RocketChatAPI(settings={'username': 'someuser', 'password': 'somepassword',
                                  'domain': 'https://myrockethchatdomain.com'})

##### Available Calls
    api.send_message('message', 'room_id')

    api.get_private_rooms()

    api.get_private_room_history('room_id', oldest=date)

    api.get_public_rooms()

    api.get_room_info('room_id')

    api.get_private_room_info('room_id')

    api.get_room_history('room_id')

    api.create_public_room('room_name', 
                            members=[], 
                            read_only=False)

    api.delete_public_room('room_id')

    api.get_my_info()

    api.get_users()

    api.get_user_info('user_id')

    api.create_user('email', 
                    'name', 
                    'password', 
                    'username', 
                     active=True, 
                     roles=['user'], 
                     join_default_channels=True, 
                     require_password_change=False, 
                     send_welcome_email=False, 
                     verified=False, 
                     customFields=None)

    api.delete_user('user_id')

    api.upload_file(room_id='room_id',
                    file='file',
                    description='File description',
                    message='Example message')

check /rocketchat/calls/api.py for more.

#### Running Tests

    py.test tests rocketchat

##### Sending a message

You'll first need to get the _id of the room you want to send a message to.  Currently, Rocket
can only send messages to *public* rooms.

    api.send_message('Your message', room_id)


