Skip to main content

Python rocketchat_API wrapper for Rocket.Chat

Project description

## rocketchat_API
Python API wrapper for [Rocket.Chat](https://rocket.chat/docs/developer-guides/rest-api)

### Instalation
- 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 Distributions

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

Built Distribution

rocketchat_API-0.3.1-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file rocketchat_API-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for rocketchat_API-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a321c4946e25cd10fdaf72781b41568386a52b9e3bb851575dd8dd577bd1b7f5
MD5 60c289ff1d59d7da638d708ed207f24e
BLAKE2b-256 5fdc1334068809b1b6c0b443cad6cca4ee9a7aded452e794517cfee7626955ee

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