Metadata-Version: 1.0
Name: django-sendsms
Version: 0.2
Summary: A simple API to send SMS messages.
Home-page: http://github.com/stefanfoulis/django-sendsms
Author: Stefan Foulis
Author-email: stefan.foulis@gmail.com
License: BSD
Description: ==============
        django-sendsms
        ==============
        
        
        A simple api to send SMS messages with django. The api is structured the same way as djangos own email api.
        
        Installation
        ============
        
        ::
        
            pip install django-sendsms
        
        Configure the ``SENDSMS_BACKEND`` (defaults to ``'sendsms.backends.console.SmsBackend'``)::
        
            SENDSMS_BACKEND = 'myapp.mysmsbackend.SmsBackend'
        
        
        Basic usage
        ===========
        
        Sending SMSs is like sending emails::
        
            from sendsms import api
            api.send_sms(body='I can haz txt', from_phone='+41791111111', to=['+41791234567'])
        
        you can also make instances of ``SmsMessage``::
        
            from sendsms.message import SmsMessage
            message = SmsMessage(body='lolcats make me hungry', from_phone='+41791111111', to=['+41791234567'])
            message.send()
        
        
        Custom backends
        ===============
        
        Creating custom ``SmsBackend`` s::
        
            from sendsms.backends.base import BaseSmsBackend
            from some.sms.delivery.api
        
            class AwesomeSmsBackend(BaseSmsBackend):
                def send_messages(self, messages):
                    for message in messages:
                        for to in message.to:
                            try:
                                some.sms.delivery.api.send(
                                    message=message.body,
                                    from_phone=message.from_phone,
                                    to_phone=to,
                                    flashing=message.flash
                                )
                            except:
                                if not self.fail_silently:
                                    raise
        
        Then all you need to do is reference your backend in the ``SENDSMS_BACKEND`` setting.
        
        
Platform: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP
