This release is a pre-release and may not be stable for production use.
chattolib
Unofficial async Python client library for the Chatto webchat API.
Chattolib versions track the Chatto server version they target. The current release targets Chatto's ConnectRPC API. Request/response traffic uses the official
connectrpcPython package; the realtime channel is a binary protobuf WebSocket at/api/realtime(needs the[realtime]extra).chattolib is a bot library. It drives bot accounts, which authenticate with a key used directly as a bearer token (no password, no
/auth/loginround-trip). Normal humans use the Chatto web app; you reach the API here as a bot. See the bot guide.
Install
pip install chattolib
Quick start
import asyncio
from chattolib import ChattoClient
async def main():
# Public discovery — no auth required
async with ChattoClient() as anon:
profile, login = await anon.get_server()
print(f"Chatto {profile.version}: {profile.name}")
# Authenticated calls — a bot key is used directly as a bearer token
async with ChattoClient(token="cht_BK_...") as client:
me = await client.me()
print(f"Authenticated as {me.display_name}")
for entry in await client.list_rooms():
if entry.room:
print(f" - {entry.room.name}")
asyncio.run(main())
For a full bot (event handlers, say/reply/react, presence, auto-join),
use the higher-level :class:~chattolib.bot.Bot facade — see
docs/bots.md.
Realtime
Install with the extra:
pip install 'chattolib[realtime]'
Then stream live events:
from chattolib import stream_events
async with ChattoClient(token="cht_BK_...") as client:
async for event in stream_events(client):
print(event.kind, event.actor_id, event.payload)
event.kind names the protobuf oneof case (message_posted,
reaction_added, presence_changed, notification_created, …).
event.payload is the concrete protobuf sub-message — access its fields
directly (e.g. event.payload.room_id). Realtime events are invalidation
signals; use the corresponding Connect RPC (GetRoomEventsAround,
GetNotification, GetUser, …) to hydrate the referenced resource.
Escape hatch
ChattoClient.services exposes the underlying connectrpc service clients
directly (one per Chatto service), for anything the Pythonic wrappers don't
yet cover. For example:
from chattolib._pb.chatto.api.v1 import messages_pb2
resp = await client.services.messages.get_message(
messages_pb2.GetMessageRequest(room_id=..., event_id=...)
)
License
- chattolib's own code is licensed under MPL-2.0 (Mozilla Public License 2.0) — a weak, file-level copyleft. You can use, distribute, and embed chattolib in commercial or proprietary software; modifications to the library's own files must be released under MPL-2.0.
- Vendored Chatto protobuf definitions under
proto/chatto/**and the generated bindings undersrc/chattolib/_pb/chatto/**are Apache-2.0, matching upstreamchattocorp/chatto. - Vendored
buf.validatematerial is Apache-2.0 (frombufbuild/protovalidate).
See LICENSING.md for the full picture and REUSE.toml for the machine-readable licence map.
Note: chattolib versions 0.0.1 through 0.4.9 were released under MIT. Those releases remain MIT-licensed forever on PyPI; the MPL-2.0 relicence applies to newly published releases only.
1 maintainer
Metadata
1 maintainer
Release files for chattolib 0.5.0b11
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 | |
|---|---|---|---|---|
| chattolib-0.5.0b11.tar.gz | 152.9 kB | Without provenance | Details |
Release files / chattolib-0.5.0b11.tar.gz
| Download URL | chattolib-0.5.0b11.tar.gz |
|---|---|
| Size | 152.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c6e675604151c0a60b68636ec3792c0f9aa5ec25d9eeb29d4dbe09441781ce75
|
|
BLAKE2b-256 checksum How to use checksums |
16ab0d3da23cf921640600b703278580db327fbe90992337b8aaafee694ef888
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.5
|
Security for chattolib 0.5.0b11
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.
