Client for Stream Chat.
Project description
stream-chat-python
:bulb: Major update in v4.0 <
The returned response objects are instances of
StreamResponseclass. It inherits fromdict, so it's fully backward compatible. Additionally, it provides other benefits such as rate limit information (resp.rate_limit()), response headers (resp.headers()) or status code (resp.status_code()).
The official Python API client for Stream chat a service for building chat applications.
You can sign up for a Stream account on our Get Started page.
You can use this library to access chat API endpoints server-side, for the client-side integrations (web and mobile) have a look at the Javascript, iOS and Android SDK libraries.
Installation
pip install stream-chat
Documentation
How to build a chat app with Python tutorial
Chat with Python, Django and React
Supported features
- Chat channels
- Messages
- Chat channel types
- User management
- Moderation API
- Push configuration
- User devices
- User search
- Channel search
- Campaign API (alpha - susceptible changes and even won't be available in some regions yet)
- Rate limit in response
Quickstart
:bulb: The library is almost 100% typed. Feel free to enable mypy for our library. We will introduce more improvements in the future in this area.
Sync
from stream_chat import StreamChat
def main():
chat = StreamChat(api_key="STREAM_KEY", api_secret="STREAM_SECRET")
# add a user
chat.update_user({"id": "chuck", "name": "Chuck"})
# create a channel about kung-fu
channel = chat.channel("messaging", "kung-fu")
channel.create("chuck")
# add a first message to the channel
channel.send_message({"text": "AMA about kung-fu"}, "chuck")
# we also expose some response metadata through a custom dictionary
resp = chat.deactivate_user("bruce_lee")
print(type(resp)) # <class 'stream_chat.types.stream_response.StreamResponse'>
print(resp["user"]["id"]) # bruce_lee
rate_limit = resp.rate_limit()
print(f"{rate_limit.limit} / {rate_limit.remaining} / {rate_limit.reset}") # 60 / 59 / 2022-01-06 12:35:00+00:00
headers = resp.headers()
print(headers) # { 'Content-Encoding': 'gzip', 'Content-Length': '33', ... }
status_code = resp.status_code()
print(status_code) # 200
if __name__ == '__main__':
main()
Async
import asyncio
from stream_chat import StreamChatAsync
async def main():
async with StreamChatAsync(api_key="STREAM_KEY", api_secret="STREAM_SECRET") as chat:
# add a user
await chat.update_user({"id": "chuck", "name": "Chuck"})
# create a channel about kung-fu
channel = chat.channel("messaging", "kung-fu")
await channel.create("chuck")
# add a first message to the channel
await channel.send_message({"text": "AMA about kung-fu"}, "chuck")
# we also expose some response metadata through a custom dictionary
resp = await chat.deactivate_user("bruce_lee")
print(type(resp)) # <class 'stream_chat.types.stream_response.StreamResponse'>
print(resp["user"]["id"]) # bruce_lee
rate_limit = resp.rate_limit()
print(f"{rate_limit.limit} / {rate_limit.remaining} / {rate_limit.reset}") # 60 / 59 / 2022-01-06 12:35:00+00:00
headers = resp.headers()
print(headers) # { 'Content-Encoding': 'gzip', 'Content-Length': '33', ... }
status_code = resp.status_code()
print(status_code) # 200
if __name__ == '__main__':
loop = asyncio.get_event_loop()
try:
loop.run_until_complete(main())
finally:
loop.run_until_complete(loop.shutdown_asyncgens())
loop.close()
Contributing
Install deps
pip install .[test, ci]
First, make sure you can run the test suite. Tests are run via py.test
export STREAM_KEY=my_api_key
export STREAM_SECRET=my_api_secret
make test
Run linters
make lint
Releasing a new version
In order to release new version you need to be a maintainer on Pypi.
- Update CHANGELOG
- Make sure you have twine installed (pip install twine)
- Update the version on setup.py
- Commit and push to Github
- Create a new tag for the version (eg.
v2.9.0) - Create a new dist with python
python setup.py sdist bdist_wheel - Upload the new distributable with twine
twine upload dist/*
If unsure you can also test using the Pypi test servers twine upload --repository-url https://test.pypi.org/legacy/ dist/stream-chat-VERSION-NAME.tar.gz
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
Built Distribution
Hashes for stream_chat-4.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4a2186e57d14cc27617bc438e3846f0e32c9c00b3e5aeb6b88a5805ba1a298c2 |
|
| MD5 | 41fb9104cd9e2c4389ed71978f2b9dd4 |
|
| BLAKE2b-256 | df11850d14c6c47a8095d14c76673c0dd7d7df5247c9da0d2d8da86c458accf2 |
