Metadata-Version: 2.1
Name: signal_cli
Version: 0.1.0
Summary: A python wrapper for the signal-cli-rest-api created by bbernhard on github
Project-URL: signal-cli-rest-api, https://github.com/bbernhard/signal-cli-rest-api
Project-URL: signal-cli-rest-api swagger, https://bbernhard.github.io/signal-cli-rest-api/
Project-URL: documentation, https://fhune.de/signal_cli_documentation/
License-File: LICENSE
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: filetype==1.2.0
Requires-Dist: pathlib==1.0.1
Requires-Dist: requests==2.22.0
Requires-Dist: typing==3.7.4.3
Description-Content-Type: text/markdown

# 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 <a href="https://github.com/bbernhard/signal-cli-rest-api">here</a>  (GitHub) and <a href="https://bbernhard.github.io/signal-cli-rest-api">here</a> (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

### License

* _signal_cli_ is [![lgpl-3.0](https://img.shields.io/badge/license-lgpl__3__0-blue.svg)](LICENSE)

### Copyright

(c) 2022 Felix Hune
