Python API wrapper for Rocket.Chat
Project description
## rocketchat_API
Python API wrapper for [Rocket.Chat](https://rocket.chat/docs/developer-guides/rest-api)
### Installation
- From pypi:
`pip3 install rocketchat_API`
- From GitHub:
Clone our repository and `python3 setup.py install`
### Requirements
- [requests](https://github.com/kennethreitz/requests)==2.13.0
### 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](https://github.com/kennethreitz/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](https://rocket.chat/docs/developer-guides/rest-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](https://demo.rocket.chat/channel/python_rocketchat_api) if you want to talk.
Python API wrapper for [Rocket.Chat](https://rocket.chat/docs/developer-guides/rest-api)
### Installation
- From pypi:
`pip3 install rocketchat_API`
- From GitHub:
Clone our repository and `python3 setup.py install`
### Requirements
- [requests](https://github.com/kennethreitz/requests)==2.13.0
### 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](https://github.com/kennethreitz/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](https://rocket.chat/docs/developer-guides/rest-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](https://demo.rocket.chat/channel/python_rocketchat_api) 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 Distribution
rocketchat_API-0.6.tar.gz
(5.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rocketchat_API-0.6.tar.gz.
File metadata
- Download URL: rocketchat_API-0.6.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
32e6fa3b38592c8b7b3ab5332378787ffc07c40f881899a0454a9b2d29c43fbf
|
|
| MD5 |
db2c3f8fdacd5c97952f7af9426d1d5a
|
|
| BLAKE2b-256 |
21d07a866f8c3486de46961e00f93da1d202986aad150bcd40e97f13f4416ff6
|
File details
Details for the file rocketchat_API-0.6-py3-none-any.whl.
File metadata
- Download URL: rocketchat_API-0.6-py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
515f173eb7a0a09ba0f122582009f5777a28be43cee7020877ddf755895259ae
|
|
| MD5 |
add4423c6cf8a74266d2bc280012e079
|
|
| BLAKE2b-256 |
bd695e8287a4c3054e4901a13cadce81429e4697363393c1e075a6beae83d34e
|