rocketchat-API 3.1.0

Python API wrapper for Rocket.Chat

rocketchat_API

Python API wrapper for Rocket.Chat

Installation

• From pypi: pip3 install rocketchat_API
• From GitHub: Clone our repository and pip install . inside the cloned folder.

Requirements

• requests

Usage

from rocketchat_API.rocketchat import RocketChat

rocket = RocketChat('user', 'pass', server_url='https://demo.rocket.chat')
rocket.me()
for channel in rocket.channels_list():
    print(channel.get("name"))
rocket.chat_post_message('good news everyone!', channel='GENERAL', alias='Farnsworth')
rocket.channels_history('GENERAL', count=5)

Using a token for authentication instead of user and password

from rocketchat_API.rocketchat import RocketChat

rocket = RocketChat(user_id='WPXGmQ64S3BXdCRb6', auth_token='jvNyOYw2f0YKwtiFS06Fk21HBRBBuV7zI43HmkNzI_s',
                    server_url='https://demo.rocket.chat')
rocket.me()

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.

Tests

We are actively testing :)

Tests run on a Rocket.Chat Docker container so install Docker and docker-compose.

1. To start test server do docker-compose up and to take test server down docker-compose down
2. To run the tests run pytest

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). Please, try to implement tests for all your code and use a PEP8 compliant code style.

Reporting bugs and asking for features is also contributing ;) Feel free to help us grow by registering issues.

We hang out here if you want to talk.

Supporters

JetBrains supports this project by providing us with licenses for their fantastic products.