Delta Chat client library for Python
Client library for Delta Chat core JSON-RPC interface
Install
pip install deltachat2
To use this library, you need to have deltachat-rpc-server program installed,
you can install it together with this library with:
pip install 'deltachat2[full]'
Usage
Example echo-bot written with deltachat2:
from deltachat2 import (
Bot,
EventType,
IOTransport,
MessageData,
NewMsgEvent,
Rpc,
events,
)
hooks = events.HookCollection()
@hooks.on(events.RawEvent)
def log_event(_bot: Bot, _accid: int, event: EventType) -> None:
"""Log all core events for debugging."""
print(event)
@hooks.on(events.NewMessage)
def echo(bot: Bot, accid: int, event: NewMsgEvent) -> None:
"""Echo back any text message"""
msg = event.msg
bot.rpc.send_msg(accid, msg.chat_id, MessageData(text=msg.text))
if __name__ == "__main__":
with IOTransport() as trans:
rpc = Rpc(trans)
bot = Bot(rpc, hooks)
accounts = rpc.get_all_account_ids()
accid = accounts[0] if accounts else rpc.add_account()
if not rpc.is_configured(accid):
rpc.set_config(accid, "bot", "1")
rpc.add_transport_from_qr(accid, "dcaccount:nine.testrun.org")
link = rpc.get_chat_securejoin_qr_code(accid, None)
print(f"Listening at: {link}")
bot.run_forever()
Save the above code in a echobot.py file and run it with Python:
python echobot.py
Then write to the bot using the invite link that will be printed in the screen.
Developing bots faster ⚡
If you want to develop bots, you probably should use this library together with deltabot-cli-py, it takes away the repetitive process of creating the bot CLI and let you focus on writing your message processing logic.
Metadata
Release files for deltachat2 2.58.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 |
|---|---|---|---|---|
| deltachat2-2.58.0.tar.gz | 49.4 kB | Without provenance | Details for deltachat2-2.58.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| deltachat2-2.58.0-py3-none-any.whl | Python 3 | none | any | Details for deltachat2-2.58.0-py3-none-any.whl |
Total release size: 98.3 kB
Release files / deltachat2-2.58.0.tar.gz
| Download URL | deltachat2-2.58.0.tar.gz |
|---|---|
| Size | 49.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4242b2db8c01db0c65abae51f971c767ccbd77d2fd7eda4084c591437b9f6a35
|
|
BLAKE2b-256 checksum How to use checksums |
e4b8dc58fe7b287de698f0f7516dd78436311d61ba38a499e27ad92e2b13b353
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Release files / deltachat2-2.58.0-py3-none-any.whl
| Download URL | deltachat2-2.58.0-py3-none-any.whl |
|---|---|
| Size | 48.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
52e630cf9cb0c727f61fa7b8412fa6b5e3666425dd6dca8eb49b4bb5bd35e085
|
|
BLAKE2b-256 checksum How to use checksums |
437290c739a27cc4b8d6ac06df73aeb01c8b2aa7299986896ce2afdd5ea31ca9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Security for deltachat2 2.58.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.