index.rst

Introduction

Rocket Python is a Python 2 and 3 library to access the REST API in RocketChat instances. The goal is to implement the entire REST API provided by RocketChat.

Installation

First step is to install via pip:

pip install rocket-python

You'll need to create an instance of the Rocket API by logging in:

from rocketchat.api import RocketChatAPI

 api = RocketChatAPI(settings={'username': 'someuser', 'password': 'somepassword',
 'domain': 'https://myrockethchatdomain.com'})

Main API Documentation

rocketchat

Detailed Module Docs

rocketchat.calls.auth rocketchat.calls.channels rocketchat.calls.groups rocketchat.calls.chat rocketchat.calls license