Metadata-Version: 2.1
Name: smsapi-client
Version: 2.3.2
Summary: SmsAPI client
Home-page: https://github.com/smsapi/smsapi-python-client
Author: SMSAPI
Author-email: bok@smsapi.pl
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: requests

﻿# smsapi-python

[![Build Status](https://travis-ci.org/smsapi/smsapi-python-client.svg?branch=master)](https://travis-ci.org/smsapi/smsapi-python-client)
[![PyPI](https://img.shields.io/pypi/v/smsapi-client.svg)](https://pypi.python.org/pypi/smsapi-client)

Client for SMSAPI.

## COMPATIBILITY

Compatible with Python 2.7+, 3.+.

## REQUIREMENTS

requests

## INSTALLATION

If You have pip installed:

    sudo pip install smsapi-client

else You can install manually:

    git clone https://github.com/smsapi/smsapi-python-client.git

    cd smsapi-python

    python setup.py install

## Client instance

If You are smsapi.pl customer You should import

```python
from smsapi.client import SmsApiPlClient
```

else You need to use client for smsapi.com

```python
from smsapi.client import SmsApiPlClient
```

## Credentials

#### Access Token

```python
from smsapi.client import SmsApiPlClient

token = "XXXX"

client = SmsApiPlClient(access_token=token)
```

## Examples

#### Send SMS

```python
from smsapi.client import SmsApiPlClient

token = "XXXX"

client = SmsApiPlClient(access_token=token)

send_results = client.sms.send(to="phone number", message="text message")

for result in send_results:
    print(result.id, result.points, result.error)
```

- **You can find more examples in "examples" directory in project files.**

## Error handling

```python
from smsapi.client import SmsApiPlClient
from smsapi.exception import SmsApiException

token = "XXXX"

client = SmsApiPlClient(access_token=token)

try:
    contact = client.sms.send(to="123123")
except SmsApiException as e:
    print(e.message, e.code)
```

## LICENSE

[Apache 2.0 License](https://github.com/smsapi/smsapi-python-client/blob/master/LICENSE)


