Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/android-sms-gateway/client-py
A Python client library for sending and managing SMS messages via the SMS Gateway for Android™ API
https://github.com/android-sms-gateway/client-py
android-sms api-client communication http-client messaging python python-library python-sdk rest-api sms sms-api sms-gateway
Last synced: about 2 months ago
JSON representation
A Python client library for sending and managing SMS messages via the SMS Gateway for Android™ API
- Host: GitHub
- URL: https://github.com/android-sms-gateway/client-py
- Owner: android-sms-gateway
- License: apache-2.0
- Created: 2024-02-08T11:02:45.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-11-15T13:25:29.000Z (2 months ago)
- Last Synced: 2024-11-15T14:25:57.124Z (2 months ago)
- Topics: android-sms, api-client, communication, http-client, messaging, python, python-library, python-sdk, rest-api, sms, sms-api, sms-gateway
- Language: Python
- Homepage: https://sms-gate.app
- Size: 90.8 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SMS Gateway for Android™ Python API Client
[](https://github.com/android-sms-gateway/client-py/blob/main/LICENSE)
[](https://github.com/android-sms-gateway/client-py/issues)
[](https://github.com/android-sms-gateway/client-py/stargazers)
[](https://github.com/android-sms-gateway/client-py/network)
[](https://pypi.org/project/android-sms-gateway/)
[](https://pypi.org/project/android-sms-gateway/)
[](https://pypi.org/project/android-sms-gateway/)
This is a Python client library for interfacing with the [SMS Gateway for Android](https://sms-gate.app) API.
## Requirements
- Python >= 3.7
- One of the following packages:
- [requests](https://pypi.org/project/requests/)
- [aiohttp](https://pypi.org/project/aiohttp/)
- [httpx](https://pypi.org/project/httpx/)
Optional:
- [pycryptodome](https://pypi.org/project/pycryptodome/) - end-to-end encryption support
## Installation
```bash
pip install android_sms_gateway
```
You can also install with preferred http client:
```bash
pip install android_sms_gateway[requests]
pip install android_sms_gateway[aiohttp]
pip install android_sms_gateway[httpx]
```
With encrypted messages support:
```bash
pip install android_sms_gateway[encryption]
```
## Quickstart
Here's an example of using the client:
```python
import asyncio
import os
from android_sms_gateway import client, domain, Encryptor
login = os.getenv("ANDROID_SMS_GATEWAY_LOGIN")
password = os.getenv("ANDROID_SMS_GATEWAY_PASSWORD")
# encryptor = Encryptor('passphrase') # for end-to-end encryption, see https://sms-gate.app/privacy/encryption/
message = domain.Message(
"Your message text here.",
["+1234567890"],
)
def sync_client():
with client.APIClient(
login,
password,
# encryptor=encryptor,
) as c:
state = c.send(message)
print(state)
state = c.get_state(state.id)
print(state)
async def async_client():
async with client.AsyncAPIClient(
login,
password,
# encryptor=encryptor,
) as c:
state = await c.send(message)
print(state)
state = await c.get_state(state.id)
print(state)
print("Sync client")
sync_client()
print("\nAsync client")
asyncio.run(async_client())
```
## Client
There are two client classes: `APIClient` and `AsyncAPIClient`. The
`APIClient` is synchronous and the `AsyncAPIClient` is asynchronous. Both
implement the same interface and can be used as context managers.
### Methods
There are two methods:
- `send(message: domain.Message) -> domain.MessageState`: Send a new SMS message.
- `get_state(_id: str) -> domain.MessageState`: Retrieve the state of a previously sent message by its ID.
## HTTP Client
The API clients abstract away the HTTP client used to make requests. The library includes support for some popular HTTP clients and trys to discover them automatically:
- [requests](https://pypi.org/project/requests/) - `APIClient` only
- [aiohttp](https://pypi.org/project/aiohttp/) - `AsyncAPIClient` only
- [httpx](https://pypi.org/project/httpx/) - `APIClient` and `AsyncAPIClient`
Also you can implement your own HTTP client that conforms to the `http.HttpClient` or `ahttp.HttpClient` protocol.
# Contributing
Contributions are welcome! Please submit a pull request or create an issue for anything you'd like to add or change.
# License
This library is open-sourced software licensed under the [Apache-2.0 license](LICENSE).