Skip to main content

Python bindings for signald

Project description

Most of the content here is generated by util/generate_api.py that uses the output of the ‘protocol’ request of the signald API.

Since this output is incomplete, a few manual additions are present in pysignald_async/api.py.

Install

pip install pysignald-async

Usage

An example can be found in this signal/XMPP gateway.

Example 1: registration

import asyncio

from pysignald_async import SignaldAPI

async def main():
    loop = asyncio.get_running_loop()
    _, signald = await loop.create_unix_connection(
        SignaldAPI, path=SIGNALD_SOCKET_PATH)
    await signald.register(username="+XXXXXX")
    # Some async code to get the SMS code
    await signald.verify(username="+XXXXXX", code=code)
    await signald.on_con_lost

SIGNALD_SOCKET_PATH = "/var/run/signald/signald.sock"

asyncio.run(main())

Example 2: echo bot

from pysignald_async.api import JsonAddressv1, JsonMessageEnvelopev1

class EchoBot(SignaldAPI):
    def handle_envelope(self, envelope: JsonMessageEnvelopev1):
        message = envelope.dataMessage
        source = envelope.source.number
        # envelopes contain typing notifications, receipts, so
        # let's check if it's actually a messages
        if message not None and source is not None:
            # signald can handle multiple accounts
            username = envelope.username
            asyncio.create_task(
                self.signald.send(
                    username=user.legacy_id,
                    recipientAddress=JsonAddressv1(
                        number=legacy_buddy_id),
                    messageBody=message.body,
                )
            )

async def main():
    loop = asyncio.get_running_loop()
    _, signald = await loop.create_unix_connection(
        SignaldAPI, path=SIGNALD_SOCKET_PATH)
    # Username is a phone number that has either been registered or linked in signald
    await signald.subscribe(username="+XXXXXX")

SIGNALD_SOCKET_PATH = "/var/run/signald/signald.sock"

asyncio.run(main())

Docs are available on readthedocs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pysignald-async, version 0.1.10
Filename, size File type Python version Upload date Hashes
Filename, size pysignald_async-0.1.10-py3-none-any.whl (12.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pysignald-async-0.1.10.tar.gz (11.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page