Metadata-Version: 2.5
Name: flashsms
Version: 0.1.0
Summary: Official FlashSMS API v2 client by Codeslaw Global Technologies
Project-URL: Homepage, https://flashsms.africa
Project-URL: Documentation, https://flashsms.africa/docs?section=sdks-python
Project-URL: Repository, https://github.com/skaduteye/bms.codeslaw
Project-URL: Source, https://github.com/skaduteye/bms.codeslaw/tree/dev/packages/sdk-python
Author: Codeslaw Global Technologies
License-Expression: MIT
Keywords: api-client,bulk-sms,codeslaw,flashsms,ghana,sms
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Communications :: Telephony
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27.0
Description-Content-Type: text/markdown

# flashsms

Official **FlashSMS** API v2 client for Python by **Codeslaw Global Technologies**.

All `send_message` calls are **live SMS** billed to your credits. Use `test_connection()` to verify your key without sending SMS.

## Install

```bash
pip install flashsms
```

## Quickstart

```python
import os
from flashsms import FlashsmsClient

client = FlashsmsClient(api_key=os.environ["FLASHSMS_API_KEY"])  # bms_live_...

# No SMS sent
balance = client.test_connection()
print("Credits:", balance["data"]["total"])

# Live SMS — charges credits
sent = client.send_message(
    message="Hello from FlashSMS",
    phones=["0201234567"],
    senderId="YourBrand",
)
```

## Environment

| Variable           | Description                |
| ------------------ | -------------------------- |
| `FLASHSMS_API_KEY` | Prepaid key (`bms_live_*`) |

## API v1

New v1 keys are no longer issued. Existing v1 keys continue to work on `/api/v1` via REST; this SDK is **v2 only**.

## License

MIT © Codeslaw Global Technologies
