RocketChat API
Python API wrapper for the Rocket chat API
Install
pip install rocket-python
Usage
Initialize the client with a username and password or token and user_id. This user must have Admin privs:
from rocketchat.api import RocketChatAPI
api = RocketChatAPI(settings={'username': 'someuser', 'password': 'somepassword',
'domain': 'https://myrockethchatdomain.com'})
# or
api = RocketChatAPI(settings={'token': 'sometoken', 'user_id': 'someuserid',
'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)
2 maintainers
Release files for rocket-python 1.3.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rocket_python-1.3.4-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Release files / rocket_python-1.3.4-py2.py3-none-any.whl
| Download URL | rocket_python-1.3.4-py2.py3-none-any.whl |
|---|---|
| Size | 22.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
5400372dcc02fc6d1090f1408f08384aedfeaa7c4b6f07a51fbbdb63ab448e4e
|
|
BLAKE2b-256 checksum How to use checksums |
f1a8da6412023ab9ef761f5a6100708746890e9312e89ac6f511c581ad359420
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.0
|
