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)

### Usage
```
from pprint import pprint
from rocketchat_API.rocketchat import RocketChat

rocket = RocketChat('myuser', 'mypassword')
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.

Project details


Release history Release notifications | RSS feed

This version

0.3

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

If you're not sure about the file name format, learn more about wheel file names.

rocketchat_API-0.3-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for rocketchat_API-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6a5e0ce0865c6010f39dc6bdafa3c58fafac0143b149f9d8bbd2a701ddc8e4e7
MD5 de23b1cd8618a174a574a7e217147f24
BLAKE2b-256 363a1d1a23fc30568bd53f4bdb2b94b78b64721babf60b790596bbc43836e197

See more details on using hashes here.

Supported by

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