Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

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.get_my_info()

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

This version
History Node

1.2.4

History Node

1.2.3

History Node

1.2.2

History Node

1.2.1

History Node

1.2.0

History Node

1.1.0

History Node

1.0

History Node

0.2

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
rocket_python-1.2.4-py2.py3-none-any.whl (12.9 kB) Copy SHA256 hash SHA256 Wheel 2.7 Jul 24, 2017
rocket-python-1.2.4.tar.gz (6.1 kB) Copy SHA256 hash SHA256 Source None Jul 24, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page