Skip to content

README.md

Latest commit

 

History

History
44 lines (33 loc) · 1.73 KB

README.md

File metadata and controls

44 lines (33 loc) · 1.73 KB

rocketchat_API

Python API wrapper for Rocket.Chat

Instalation

  • From pypi: pip3 install rocketchat_API
  • From GitHub: Clone our repository and python3 setup.py install

Requirements

Usage

from pprint import pprint
from rocketchat_API.rocketchat import RocketChat

proxyDict = {
              "http"  : "http://127.0.0.1:3128",
              "https" : "https://127.0.0.1:3128",
            }

rocket = RocketChat('user', 'pass', server_url='https://demo.rocket.chat', proxies=proxyDict)
pprint(rocket.me().json())
pprint(rocket.channels_list().json())
pprint(rocket.chat_post_message('GENERAL', 'good news everyone!', alias='Farnsworth').json())
pprint(rocket.channels_history('GENERAL', count=5).json())

note: every method returns a requests Response object.

Method parameters

Only required parameters are explicit on the RocketChat class but you can still use all other parameters. For a detailed parameters list check the Rocket chat API

API coverage

I've implemented only a few methods until now but I want to make them all. If you are interested in a specific call just open an issue or open a pull request.

note: This have being tested only on Rocket.Chat >= 0.52.0

Tests

No tests have being implemented. If you are interested in writing them please open a pull request.

Contributing

You can contribute by doing Pull Requests. (It may take a while to merge your code but if it's good it will be merged). We hang out here if you want to talk.