Metadata-Version: 2.0
Name: dj-twilio-sms
Version: 1.0.0
Summary: Twilio SMS Integration for Django
Home-page: https://github.com/mastizada/dj-twilio-sms
Author: Emin Mastizada
Author-email: emin@linux.com
License: MIT
Download-URL: https://github.com/mastizada/dj-twilio-sms/zipball/master
Keywords: django twilio sms
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: Django
Requires-Dist: djangorestframework (>=2.4.7)
Requires-Dist: twilio (>=5.6.0)

dj-twilio-sms
=================

Twilio SMS Integration for Django

.. image:: https://badge.fury.io/py/dj-twilio-sms.svg
    :target: https://pypi.python.org/pypi/dj-twilio-sms/
    :alt: pypi
.. image:: https://travis-ci.org/mastizada/dj-twilio-sms.svg?branch=master
    :target: https://travis-ci.org/mastizada/dj-twilio-sms
    :alt: travis

This is fork of `nigma/django-twilio-sms` (Filip Wasilewski en[at]ig[dot]ma) as original package has stopped maintenance.

Django 1.10 support, migrations, timezone improvements.

Used for SMS messages in SiteLedger project.


Quickstart
----------

1. Include ``dj-twilio-sms`` in your ``requirements.txt`` file.

2. Add ``dj_twilio_sms`` to ``INSTALLED_APPS`` and migrate (manage.py migrate).

3. Add the following url to your urlconf:

   .. code-block:: python

       url(r"^messaging/", include("dj_twilio_sms.urls")),

   this will receive confirmation callbacks for any SMS message
   that you send using ``utils.send_sms``.

4. Create a new view and override ``IncomingSMSView.post_save(self, obj)`` method
   to receive SMS messages via callbacks from Twilio. The received ``obj``
   param will be an instance of ``IncomingSMS`` model.

5. Configure Twilio callback to send notifications to the above view's url.

6. Configure settings:

   - TWILIO_ACCOUNT_SID, TWILIO_AUTH_TOKEN, TWILIO_PHONE_NUMBER - copy
     credentials from the Twilio panel.

   - TWILIO_CALLBACK_USE_HTTPS - use https or not for delivery confirmation
     callback urls.

   - TWILIO_CALLBACK_DOMAIN - optionally set domain name or IP of your site
     (otherwise the server name will be extracted from the request info).

   - TWILIO_DRY_MODE - set if you want to run in test mode.


Django Version Support
----------------------

- Django 1.8, 1.9 and 1.10
- Python 2.7 and 3.5

It should work with Django 1.6 and 1.7, but you need to downgrade django-rest-framework for these versions.


License
-------

``django-twilio-sms`` and ``dj-twilio-sms`` is released under the MIT license.

Other Resources
---------------

- GitHub repository - https://github.com/mastizada/dj-twilio-sms
- PyPi Package site - https://pypi.python.org/pypi/dj-twilio-sms


