Metadata-Version: 2.1
Name: smsframework-pswin
Version: 0.3.4
Summary: SMS framework: PSWin provider 
Home-page: https://github.com/dignio/py-smsframework-pswin
Author: Dignio
License: MIT
Keywords: sms,message,notification,receive,send,pswin
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: smsframework (>=0.0.9)
Requires-Dist: requests (>=2.4.3)
Provides-Extra: receiver
Requires-Dist: flask (>=0.10) ; extra == 'receiver'

[![Build Status](https://api.travis-ci.org/dignio/py-smsframework-pswin.png?branch=master)](https://travis-ci.org/dignio/py-smsframework-pswin)
[![Pythons](https://img.shields.io/badge/python-2.7%20%7C%203.4%E2%80%933.7%20%7C%20pypy-blue.svg)](.travis.yml)

SMSframework PSWinCom Provider
================================

[PSWin](https://wiki.pswin.com/) Provider for [smsframework](https://pypi.python.org/pypi/smsframework/).






Installation
============

Install from pypi:

    $ pip install smsframework_pswin

To receive SMS messages, you need to ensure that
[Flask microframework](http://flask.pocoo.org) is also installed:


    $ pip install smsframework_pswin[receiver]






Initialization
==============

```python
from smsframework import Gateway
from smsframework_pswin import PswinProvider

gateway = Gateway()
gateway.add_provider('pswin', PswinProvider,
    user='dignio',
    password='123',
    hostname='foo.pswin.com',  # Defaults to 'simple.pswin.com'
    https=True
)
```

Config
------

Source: /smsframework_pswin/provider.py

* `user: str`: Account username
* `password: str`: Account password
* `hostname: str`: Provider hostname
* `https: bool`: Use HTTPS for outgoing messages? Default: `False`






Receivers
=========

Source: /smsframework_pswin/receiver.py

Message Receiver: /im
---------------------
Login to https://accountweb.pswin.com/ using your account details and edit the section "Mobile Originated (MO) messages forwarding configuration"

Protocol: HTTP
Value: `<protocol>://<server-name>/<provider-name>/im`


Status Receiver: /status
------------------------
Login to https://accountweb.pswin.com/ using your account details and edit the section "Delivery Reports (DR) forwarding configuration"

Protocol: HTTP
Value: `<protocol>://<server-name>/<provider-name>/status`


