Python API wrapper for Rocket.Chat
Project description
rocketchat_API
Python API wrapper for Rocket.Chat
Installation
- From pypi:
pip3 install rocketchat_API
- From GitHub:
Clone our repository and
python3 setup.py install
Requirements
- requests==2.18.4
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('good news everyone!', channel='GENERAL', 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
Most of the API methods are already implemented. If you are interested in a specific call just open an issue or open a pull request.
note: Library updated to work with Rocket.Chat >= 0.65.1
Tests
We are actively testing :)
Tests run on a Rocket.Chat Docker container so install Docker and docker-compose. To start test server do docker-compose -f docker-compose-test-setver.yml up
and to take test server down docker-compose -f docker-compose-test-setver.yml down
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). Please, try to implement tests for all your code and use a PEP8 compliant code style.
Reporting bugs and asking for features is also contributing ;) Feel free to help us grow by registering issues.
We hang out here if you want to talk.
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
Built Distributions
Hashes for rocketchat_API-0.6.16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39deb798a6356360a9979d900b688bd3a7bbc385fbbe4cc34ccb9c7a2e188385 |
|
MD5 | 00c891c6e2d2b2493933a4e87ad72572 |
|
BLAKE2b-256 | 09ffc03753cc417d01a4e9aa6f521862b28045f9b57945ae9a8f1d3c765ea8aa |
Hashes for rocketchat_API-0.6.16-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 392b6f1f8d767b9be39cae644c8c4a482e15df4c3edb6b50ea37d1d87639f9a8 |
|
MD5 | 711a2aa42809dac1b35d2095377e8827 |
|
BLAKE2b-256 | caf5eb45471fc366ff2f1abb9045c95230f90b926f2144c170fb0cff8c142b7c |