Skip to main content

A python wrapper for the signal-cli-rest-api created by bbernhard on github

Project description

signal-cli - A python wrapper for the signal-cli-rest-api

Documentation

The documentation of the code can be found here: https://fhune.de/signal_cli_documentation/

For the documentation of the signal-cli-rest-api, see here (GitHub) and here (Swagger).

Quick Start

  • For using the module, you have to create a client object first: signal_cli.Client(<address>, <port>, <phone_number>), with address and port building the access point to the signal-cli-rest-api and number building the phone number which should be used as client number.
  • After creating the client object, you can use the other methods in their respective classes by passing the client object to the class object the method is in
  • Special care needs to be taken if you plan to register a number with getting the code via voice; read the documentation of the code for further details!

License

  • signal_cli is lgpl-3.0

Copyright

(c) 2023 Felix Hune

Project details


Download files

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

Source Distribution

signal_cli-0.1.4.tar.gz (9.6 kB view hashes)

Uploaded Source

Built Distribution

signal_cli-0.1.4-py3-none-any.whl (16.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page