Python API wrapper for Rocket.Chat
Project description
rocketchat_API
Python API wrapper for Rocket.Chat
Do you like my library? buy me a 🍺 ➡️ or
Installation
- From pypi:
pip3 install rocketchat_API
- From GitHub:
Clone our repository and
python3 setup.py install
Requirements
- requests==2.20.1
Usage
from pprint import pprint
from rocketchat_API.rocketchat import RocketChat
proxy_dict = {
"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=proxy_dict)
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.72.0
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-server.yml up
and to take test server down docker-compose -f docker-compose-test-server.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.
Sponsors
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.27-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9a414a343407eeb71d363e957ac51eeba41648e24d5a74f47fdbdb2dd7f5ed7 |
|
MD5 | 7a2fca8545dc0426db0d7a7c3c53837e |
|
BLAKE2b-256 | 5fc0117b97e5b4e057808b4db1dda3bfb9aef46e502b7f8107bc8e33d2df7ee9 |
Hashes for rocketchat_API-0.6.27-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb8e5d3817f30281a83961f3a2962e23ae73c4267e3494261a722fc0e5f9990a |
|
MD5 | f8d3d1b3645f50d75e1046b46f9606bf |
|
BLAKE2b-256 | 1fc127794bd07e6c4923489ddb56d506513b8d58aed4f8f60db758d90b1a6e88 |