stream-chat-python
the official Python API client for Stream chat a service for building chat applications.
You can sign up for a Stream account at https://getstream.io/chat/get_started/.
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 (https://getstream.io/chat/).
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
Quickstart
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")
Contributing
First, make sure you can run the test suite. Tests are run via py.test
STREAM_KEY=my_api_key STREAM_SECRET=my_api_secret py.test stream_chat/ -v
Install black and pycodestyle
pip install black
pip install pycodestyle
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 - Upload the new distributable with twine
twine upload dist/stream-chat-VERSION-NAME.tar.gz
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
Metadata
Release files for stream-chat 1.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| stream-chat-1.7.0.tar.gz | 14.2 kB | Without provenance | Details for stream-chat-1.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| stream_chat-1.7.0-py3-none-any.whl | Python 3 | none | any | Details for stream_chat-1.7.0-py3-none-any.whl |
Total release size: 34.2 kB
Release files / stream-chat-1.7.0.tar.gz
| Download URL | stream-chat-1.7.0.tar.gz |
|---|---|
| Size | 14.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ce38079f5d61756d1e2a03f19d443cdce5b26f5af11a5e723eba53668f1b127d
|
|
BLAKE2b-256 checksum How to use checksums |
4af2f82f5262411c00a7b598fa4f5eab3cdd4609ec3d50f7fd5381419224478a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6
|
Release files / stream_chat-1.7.0-py3-none-any.whl
| Download URL | stream_chat-1.7.0-py3-none-any.whl |
|---|---|
| Size | 20.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d22fdbda95dda0804524a06dd94712855750c619f2ccd0ced923834d1499608a
|
|
BLAKE2b-256 checksum How to use checksums |
e3d417d893dd428ddee9cc725aaeb6fd11034fc61c5e1d54739d57803621570a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6
|
Security for stream-chat 1.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.