Skip to content

gita-dev/rocket-python

 
 

Repository files navigation

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

Documentation

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_id('chanel_name')
api.get_private_room_history('room_id', oldest=date, message_count = 20)
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.

Calls Descriptions
api.get_private_room_id('chanel_name') - Return's room identifer for called chanel name 

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)

About

RocketChat API Implemented in Python

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.0%
  • Makefile 1.0%