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('good news everyone!', channel='GENERAL', 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
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.58.0
### Tests
We started writing tests :D
Tests run on a Rocket.Chat Docker container so install Docker and run `tests/run_rocketchat.sh` and whe Rocket.Chat is active run `py.test tests/tests.py`. After testing, remember to stop and remove containers run `tests/stop_rocketchat.sh`
We are on an early stage testing so must of the code is still untested. There is an open issue on this and help is wanted ;)
### 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('good news everyone!', channel='GENERAL', 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
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.58.0
### Tests
We started writing tests :D
Tests run on a Rocket.Chat Docker container so install Docker and run `tests/run_rocketchat.sh` and whe Rocket.Chat is active run `py.test tests/tests.py`. After testing, remember to stop and remove containers run `tests/stop_rocketchat.sh`
We are on an early stage testing so must of the code is still untested. There is an open issue on this and help is wanted ;)
### 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.2.tar.gz
(5.2 kB
view hashes)
Built Distributions
Close
Hashes for rocketchat_API-0.6.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2668f4000e76b3144a73d78e2488bffc15d749b3ce65b8a4ba8c917bf72b3667 |
|
MD5 | 334bfbe6c7cbc1dd56f9938933e29302 |
|
BLAKE2b-256 | 61cd3888d513b7341b4a724d347fcba899d5a29152ff67a0a97374ce81561936 |
Close
Hashes for rocketchat_API-0.6.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4547fadb520e0bac4191970bd4b591f6aca3261a602b4331a2216dbd818b296 |
|
MD5 | 40383adc23948e8e918fc2badd459054 |
|
BLAKE2b-256 | 2a7749613fa2090bf387f8e725766caed0b1843e0a4c311697684b80e5e79eec |