django-nexmo

django-nexmo is a tiny Django app to send sms using the Nexmo provider. The actual communication with Nexmo's API is delegated to the nexmo python lib.

Warning between version 1.0 and 2.0, we ditched the obsolete and unsupported libnexmo and had to change the conflicting package name. If you are migrating from an old django-nexmo version, you might have to change your imports from nexmo to djexmo.

Installation

Installation using pip is simple:

$ pip install django-nexmo==2.0.0a1

Add the nexmo app to your installed applications:

INSTALLED_APPS = (
    …
    'djexmo',
    …
)

Configuration

You need to add a few lines in your settings.py file for django-nexmo to work:

NEXMO_API_KEY = 'API_KEY'
NEXMO_API_SECRET = 'SECRET'
NEXMO_DEFAULT_FROM = 'Name or phone'

Did I mention that you need a Nexmo account? Seems quite obvious to me.

You can get your API_KEY and SECRET from your Nexmo Dashboard

Basic usage

The djexmo apps gives you access to a shortcut to send text messages easily.

from djexmo import send_message
send_message(frm='+33123456789', to='+33612345678', text='My sms message body')

The frm parameter can be omited. In that case, the NEXMO_FROM configuration field will be used instead.

from djexmo import send_message
send_message(to='+33612345678', text='My sms message body')

Advanced usage

django-nexmo uses the official nexmo lib. Therefore, you can use the library for a low level access to the Nexmo API.

Handling callbacks

Nexmo can call one of your urls to send further details about a text message processing.

django-nexmo provides a very basic callback handler that does nothing but logging Nexmo calls.

In your main urls.py file:

urlpatterns = patterns('',
    …
    url(r'^nexmo/', include('djexmo.urls')),
    …
)

This will declare a callback view accessible through the http://your-site.url/nexmo/callback/ url.

Copy this url and paste it in the "Callback URL" section of your "API settings" section of your Nexmo.com account.

Testing

django-nexmo uses tox for testing in multiple environments.

To run the tests, create a new virtualenv, then pip install tox. To run the tests:

tox

Credits

Crafted with love by Thibault Jouannic. Available for Python / Django Freelancing.