RocketChat API with Python
Project description
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)
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
File details
Details for the file rocket_python-1.3.0-py2.py3-none-any.whl.
File metadata
- Download URL: rocket_python-1.3.0-py2.py3-none-any.whl
- Upload date:
- Size: 22.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ae217bbf5a7a570322c4ba53a2908d77b085e30b59a28a24a110b9413bfce7b6 |
|
| MD5 | 521c199bad03e34aff1e35ad9e2c3715 |
|
| BLAKE2b-256 | 10e474d61d1195f771d128d2aec77591b7a897bc0b5042241edcbc58bea4191d |
