Skip to content

Commit 7626afa

Browse files
committed
[docs] unify README
1 parent f32953f commit 7626afa

File tree

1 file changed

+38
-23
lines changed

1 file changed

+38
-23
lines changed

README.md

Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,32 @@
44
[![PyPI Version](https://img.shields.io/pypi/v/android-sms-gateway.svg?style=for-the-badge)](https://pypi.org/project/android-sms-gateway/)
55
[![Python Version](https://img.shields.io/pypi/pyversions/android-sms-gateway.svg?style=for-the-badge)](https://pypi.org/project/android-sms-gateway/)
66
[![Downloads](https://img.shields.io/pypi/dm/android-sms-gateway.svg?style=for-the-badge)](https://pypi.org/project/android-sms-gateway/)
7-
[![GitHub Issues](https://img.shields.io/github/issues/capcom6/android-sms-gateway-py.svg?style=for-the-badge)](https://github.com/android-sms-gateway/client-py/issues)
8-
[![GitHub Stars](https://img.shields.io/github/stars/capcom6/android-sms-gateway-py.svg?style=for-the-badge)](https://github.com/android-sms-gateway/client-py/stargazers)
9-
[![GitHub Forks](https://img.shields.io/github/forks/capcom6/android-sms-gateway-py.svg?style=for-the-badge)](https://github.com/android-sms-gateway/client-py/network)
7+
[![GitHub Issues](https://img.shields.io/github/issues/android-sms-gateway/client-py.svg?style=for-the-badge)](https://github.com/android-sms-gateway/client-py/issues)
8+
[![GitHub Stars](https://img.shields.io/github/stars/android-sms-gateway/client-py.svg?style=for-the-badge)](https://github.com/android-sms-gateway/client-py/stargazers)
9+
[![GitHub Forks](https://img.shields.io/github/forks/android-sms-gateway/client-py.svg?style=for-the-badge)](https://github.com/android-sms-gateway/client-py/network)
1010
[![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/android-sms-gateway/client-py?style=for-the-badge)](https://www.coderabbit.ai)
1111

1212
A modern Python client for seamless integration with the [SMS Gateway for Android](https://sms-gate.app) API. Send SMS messages programmatically through your Android devices with this powerful yet simple-to-use library.
1313

14-
## ✨ Features
14+
## 📖 About The Project
1515

16-
- 🚀 **Dual Client**: Supports both synchronous (`APIClient`) and asynchronous (`AsyncAPIClient`) interfaces
17-
- 🔒 **End-to-End Encryption**: Optional message encryption using AES-256-CBC
18-
- 🌐 **Multiple HTTP Backends**: Native support for `requests`, `aiohttp`, and `httpx`
19-
- 🔗 **Webhook Management**: Programmatically create, query, and delete webhooks
20-
- ⚙️ **Customizable Base URL**: Point to different API endpoints
21-
- 📝 **Full Type Hinting**: Fully typed for better development experience
22-
- 🛡️ **Robust Error Handling**: Specific exceptions and clear error messages
23-
- 📊 **Delivery Reports**: Track your message delivery status
16+
The Python client for SMSGate provides a clean, type-safe interface to interact with the SMSGate API. It's designed specifically for Python developers who need to integrate SMS functionality into their applications with minimal setup and maximum reliability.
17+
18+
Key value propositions:
2419

25-
## 📖 Table of Contents
20+
- 🐍 **Pythonic API** - Designed with Python conventions and best practices in mind
21+
- 🛡️ **Robust Security** - Guidance for secure credential handling and optional end‑to‑end encryption
22+
- 🔄 **Flexible Architecture** - Supports both synchronous and asynchronous programming patterns
23+
- 💻 **Type Safety** - Full type hinting for better developer experience and fewer runtime errors
24+
- 🔗 **Webhook Integration** - Simplified webhook management for event-driven architectures
2625

26+
This client abstracts away the complexities of the underlying HTTP API while providing all the necessary functionality to send and track SMS messages through Android devices.
27+
28+
## 📚 Table of Contents
2729
- [📱 SMS Gateway for Android™ Python API Client](#-sms-gateway-for-android-python-api-client)
30+
- [📖 About The Project](#-about-the-project)
31+
- [📚 Table of Contents](#-table-of-contents)
2832
- [✨ Features](#-features)
29-
- [📖 Table of Contents](#-table-of-contents)
3033
- [⚙️ Requirements](#️-requirements)
3134
- [📦 Installation](#-installation)
3235
- [Basic Installation](#basic-installation)
@@ -56,6 +59,18 @@ A modern Python client for seamless integration with the [SMS Gateway for Androi
5659
- [📄 License](#-license)
5760
- [🤝 Support](#-support)
5861

62+
63+
## ✨ Features
64+
65+
- 🔄 **Dual Client**: Supports both synchronous (`APIClient`) and asynchronous (`AsyncAPIClient`) interfaces
66+
- 🔒 **End-to-End Encryption**: Optional message encryption using AES-256-CBC
67+
- 🌐 **Multiple HTTP Backends**: Native support for `requests`, `aiohttp`, and `httpx`
68+
- 🔗 **Webhook Management**: Programmatically create, query, and delete webhooks
69+
- ⚙️ **Customizable Base URL**: Point to different API endpoints
70+
- 💻 **Full Type Hinting**: Fully typed for better development experience
71+
- ⚠️ **Robust Error Handling**: Specific exceptions and clear error messages
72+
- 📈 **Delivery Reports**: Track your message delivery status
73+
5974
## ⚙️ Requirements
6075

6176
- **Python**: 3.9 or higher
@@ -180,13 +195,13 @@ with client.APIClient(login, password, encryptor=encryptor) as c:
180195

181196
Both clients (`APIClient` and `AsyncAPIClient`) support these parameters:
182197

183-
| Parameter | Type | Description | Default |
184-
| ----------- | ------------ | ------------------- | ---------------------------------------- |
185-
| `login` | `str` | API username | **Required** |
186-
| `password` | `str` | API password | **Required** |
187-
| `base_url` | `str` | API base URL | `"https://api.sms-gate.app/3rdparty/v1"` |
188-
| `encryptor` | `Encryptor` | Encryption instance | `None` |
189-
| `http` | `HttpClient` | Custom HTTP client | Auto-detected |
198+
| Parameter | Type | Description | Default |
199+
| ----------- | ------------------------------ | ------------------- | ---------------------------------------- |
200+
| `login` | `str` | API username | **Required** |
201+
| `password` | `str` | API password | **Required** |
202+
| `base_url` | `str` | API base URL | `"https://api.sms-gate.app/3rdparty/v1"` |
203+
| `encryptor` | `Encryptor` | Encryption instance | `None` |
204+
| `http` | `HttpClient`/`AsyncHttpClient` | Custom HTTP client | Auto-detected |
190205

191206
### Available Methods
192207

@@ -250,7 +265,7 @@ The library automatically detects installed HTTP clients with this priority:
250265
### Using Specific Clients
251266

252267
```python
253-
from android_sms_gateway import http
268+
from android_sms_gateway import client, http
254269

255270
# Force httpx usage
256271
client.APIClient(..., http=http.HttpxHttpClient())
@@ -265,7 +280,7 @@ async with client.AsyncAPIClient(..., http=http.AiohttpHttpClient()) as c:
265280

266281
### Custom HTTP Client
267282

268-
Implement your own HTTP client following the `http.HttpClient` or `ahttp.HttpClient` protocols.
283+
Implement your own HTTP client following the `http.HttpClient` (sync) or `ahttp.AsyncHttpClient` (async) protocols.
269284

270285
## 🔒 Security
271286

0 commit comments

Comments
 (0)