RocketChat API with Python
Project description
#### RocketChat API
> Looking For Authors! This project is currently looking for a user to take it over. If that sounds like you, send a note to derek at stegelman dot com or open up an issue in this repository.
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’)
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)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for rocket_python-1.2.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55e6b957ea13c659a5803c5be5f33b4cd3e6b42a979855641369043bc9188d25 |
|
MD5 | 83212f961764d6ca7727029adb6e6985 |
|
BLAKE2b-256 | 9c47acf1dfc819c278b79a81c229d8f318d2b24a6db6d358c923d3a75a68e9b2 |