rocketchat_API
Python API wrapper for Rocket.Chat
Installation
From PyPI (recommended):
pip install rocketchat_API
From source:
git clone https://github.com/jadolg/rocketchat_API.git
cd rocketchat_API
pip install .
Requirements
- Python 3.10 or higher
- requests
Compatibility
This library is tested against all supported versions of Python and Rocket.Chat. It is also continuously tested against the latest Rocket.Chat release to ensure compatibility with new versions.
We do not guarantee any compatibility outside of the tested versions.
See the Test GitHub Action to get the list of tested versions.
Usage
Basic Authentication
from rocketchat_API.rocketchat import RocketChat
rocket = RocketChat('user', 'pass', server_url='https://demo.rocket.chat')
# Get current user info
rocket.me()
# List all channels
for channel in rocket.channels_list():
print(channel.get("name"))
# Post a message
rocket.chat_post_message('good news everyone!', channel='GENERAL', alias='Farnsworth')
# Get channel history
rocket.channels_history('GENERAL', max_count=5)
Token-Based Authentication
If you already have a user ID and authentication token, you can use them directly:
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 explicitly defined in the RocketChat class methods. However, you can pass any additional parameters supported by the Rocket.Chat API. For a complete list of available parameters, refer to the official Rocket.Chat API documentation.
Development
Setting Up the Development Environment
- Clone the repository:
git clone https://github.com/jadolg/rocketchat_API.git
cd rocketchat_API
- Install development dependencies:
pip install -e ".[test]"
Running Tests
Tests run against a Rocket.Chat instance in Docker. Make sure you have Docker and Docker Compose installed.
- Start the test server:
docker compose up -d
- Wait for Rocket.Chat to be ready:
until curl --silent http://localhost:3000/api/info/; do sleep 15; echo "waiting for Rocket.Chat server to start"; done
- Run the tests:
pytest
- To run tests with coverage:
pytest --cov=rocketchat_API
- When finished, stop the test server:
docker compose down
Code Style
This project uses black for code formatting. All code must be formatted with black before submitting a pull request.
To format your code:
black .
To check if your code is properly formatted:
black --check --diff .
The CI pipeline will automatically reject pull requests that are not properly formatted.
Contributing
See CONTRIBUTING.md for guidelines on how to contribute to this project.
License
This project is licensed under the MIT License. See LICENSE.txt for details.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rocketchat_api-3.7.1.tar.gz.
File metadata
- Download URL: rocketchat_api-3.7.1.tar.gz
- Upload date:
- Size: 91.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
915e7eeeddcdca02601fe06e4fbc596f45a5d366a71c72f3fb48f6103708696c
|
|
| MD5 |
3ae44da063ad7b2e9d746a08f5125dce
|
|
| BLAKE2b-256 |
fd31440f15fe378aa3f14b11bde8b6db3c1922e6a2a7d3a9089afc9ae1c73f85
|
Provenance
The following attestation bundles were made for rocketchat_api-3.7.1.tar.gz:
Publisher:
release.yml on jadolg/rocketchat_API
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
rocketchat_api-3.7.1.tar.gz -
Subject digest:
915e7eeeddcdca02601fe06e4fbc596f45a5d366a71c72f3fb48f6103708696c - Sigstore transparency entry: 2381346784
- Sigstore integration time:
-
Permalink:
jadolg/rocketchat_API@e845a9551018dfeee5dc625e061969b524e217e0 -
Branch / Tag:
refs/tags/3.7.1 - Owner: https://github.com/jadolg
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@e845a9551018dfeee5dc625e061969b524e217e0 -
Trigger Event:
release
-
Statement type:
File details
Details for the file rocketchat_api-3.7.1-py3-none-any.whl.
File metadata
- Download URL: rocketchat_api-3.7.1-py3-none-any.whl
- Upload date:
- Size: 30.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ad07005312a7f68572960c4768a9a7b9512a4f60c83d15273f5917bf655d49a1
|
|
| MD5 |
51087ca9cab5e6c026a824149001a7d8
|
|
| BLAKE2b-256 |
7b049f8e28e558e013c760f7d4e1b40ba540119cbfbf338fee9f0a6736fa6350
|
Provenance
The following attestation bundles were made for rocketchat_api-3.7.1-py3-none-any.whl:
Publisher:
release.yml on jadolg/rocketchat_API
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
rocketchat_api-3.7.1-py3-none-any.whl -
Subject digest:
ad07005312a7f68572960c4768a9a7b9512a4f60c83d15273f5917bf655d49a1 - Sigstore transparency entry: 2381347856
- Sigstore integration time:
-
Permalink:
jadolg/rocketchat_API@e845a9551018dfeee5dc625e061969b524e217e0 -
Branch / Tag:
refs/tags/3.7.1 - Owner: https://github.com/jadolg
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@e845a9551018dfeee5dc625e061969b524e217e0 -
Trigger Event:
release
-
Statement type:
