Skip to main content

Python API wrapper for Rocket.Chat

Project description

## rocketchat_API
Python API wrapper for [Rocket.Chat](https://docs.rocket.chat/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://docs.rocket.chat/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 docker-compose. To start test server do `docker-compose up` on `tests/testserver` and to take test server down `docker-compose 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). 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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

rocketchat_API-0.6.8-py2.py3-none-any.whl (6.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file rocketchat_API-0.6.8-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for rocketchat_API-0.6.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b6010b1becf391c4ac33605c8e3847dcfc71d8e0174127d30956f8f05cf1e28d
MD5 b3e65a872869925b7fc73258c6ae10e2
BLAKE2b-256 b26b72fe6403ba5ef08a32ab768ba93df56b0ca5c59bd97f5c8d1cd2c378007e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page