RocketChat API with Python
Project description
#### 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)
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)
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for rocket_python-1.2.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ccb6a0f7413ea41bd84352f29d0288626d7d6bf0fec815f88acff42ccc222ab |
|
MD5 | 9fa39d048a3417501bf27466e61de8db |
|
BLAKE2b-256 | 43dfa04273a8504d78ee8d017009f745cae6c958e4e2528d0b9a4adca2f34a4e |