Skip to main content

Django models for Twilio's Programmable SMS

Project description

=============================
django-twilio-sms-models
=============================

.. image:: https://badge.fury.io/py/django-twilio-sms-models.png
:target: https://badge.fury.io/py/django-twilio-sms-models

.. image:: https://travis-ci.org/cfc603/django-twilio-sms-models.png?branch=master
:target: https://travis-ci.org/cfc603/django-twilio-sms-models

.. image:: https://codecov.io/github/cfc603/django-twilio-sms-models/coverage.svg?branch=master
:target: https://codecov.io/github/cfc603/django-twilio-sms-models?branch=master

Django models for Twilio's Programmable SMS

Documentation
-------------

The full documentation is at https://django-twilio-sms-models.readthedocs.org.

Quickstart
----------

Install django-twilio-sms-models::

$ pip install django-twilio-sms-models

Follow django-twilio install instructions:

http://django-twilio.readthedocs.org/en/latest/install.html

Add 'django-twilio-sms' to your `INSTALLED_APPS`::

# project/settings.py
INSTALLED_APPS = (
...
'django_twilio_sms',
)

Set 'DJANGO_TWILIO_SMS_SITE_HOST' setting:

This is used to build an absolute URI for the callback url. Can also be used
with ngrok on your development machine.

::

# project/settings.py
DJANGO_TWILIO_SMS_SITE_HOST = 'www.example.com'

Include django-twilio-sms URLconf in your project `urls.py`::

url(r'^twilio-integration/', include('django_twilio_sms.urls', namespace='django_twilio_sms')),

Sync the database::

$ python manage.py migrate

Running Tests
--------------

Does the code actually work?

::

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements-test.txt
(myenv) $ python runtests.py

Credits
---------

Tools used in rendering this package:

* Cookiecutter_
* `cookiecutter-pypackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage




History
-------

1.2.0 (2016-05-13)
++++++++++++++++++

* Handle unsubscribed PhoneNumber


1.1.0 (2016-04-16)
++++++++++++++++++

* Basic admin configuration (#4) (Thanks @carlkibler)
* Update docs
* Fix settings typo
* Add response_message signal


1.0.0 (2016-04-14)
++++++++++++++++++

* Setup tox
* Setup Travis CI
* Add sync_responses command


0.1.0 (2016-04-11)
++++++++++++++++++

* First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-twilio-sms-models-1.2.0.tar.gz (12.1 kB view hashes)

Uploaded Source

Built Distribution

django_twilio_sms_models-1.2.0-py2.py3-none-any.whl (13.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page