Skip to main content

Python API wrapper for Rocket.Chat

Project description

rocketchat_API

Python API wrapper for Rocket.Chat

Codacy Badge Build Status

Installation

  • From pypi: pip3 install rocketchat_API
  • From GitHub: Clone our repository and python3 setup.py install

Requirements

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 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

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 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.13.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file rocketchat_API-0.6.13.tar.gz.

File metadata

File hashes

Hashes for rocketchat_API-0.6.13.tar.gz
Algorithm Hash digest
SHA256 63ea27257afc844878a962bfefb9f809c170cbc953716f493e6f4f9efeb8cad4
MD5 18c511e2f0431487ad3f047b7bff2ea2
BLAKE2b-256 09c76dae778b37705b630bd0ca45abe8b923de2a1ac5b00776dee3d1dcd884a1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rocketchat_API-0.6.13-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 822db47a6ed7f9c9249a6b825ef641b13d39ed0ee87eaa6a2f49a8d2eddb1446
MD5 adbbae53c36272587123a98181ceefab
BLAKE2b-256 08a9acbf9c48bc08f64ba0d1b9754214b00e16747f54ffaea2b22895ad801cc9

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