It's a Django module to send and store SMS with Twilio.
Project description
Django SMS Toolkit
Django module to send and store SMS with Twilio.
Releases
To release a new version via github.com, follow the steps in this link.
To release a new version via git commands, follow this documentation.
You can see the releases here.
Versioning
You can refer here for semantics of versioning.
Installation
-
pip install
django-sms-toolkit
. -
Add django_sms_toolkit to the
INSTALLED_APPS
in the settings file. -
Configure settings.
DJANGO_SMS_TOOLKIT_SETTINGS = {
"SEND_SMS": True, # True by default.
"DEFAULT_FROM_NUMBER": "",
"TWILIO": {
"ACCOUNT_SID": "",
"AUTH_TOKEN": "",
"STATUS_CALLBACK_BASE_URL": "https://www.myapp.com",
"TRIM_LONG_BODY": True, # True by default. Makes sure character limit is not exceeded.
}
}
-
python manage.py migrate
-
Include urls to be able to receive message status callbacks from Twilio.
urlpatterns = [
....,
url(r'^', include('django_sms_toolkit.urls')),
]
- (Optional) Add
TwilioMessageMixin
to your auth user model.
from django_sms_toolkit.models import TwilioMessageMixin
class AuthUser(TwilioMessageMixin,...):
....
# Default from number provided in settings is used if from_number is not provided.
user.send_sms(body, from_number=None)
# OR
from django_sms_toolkit.tasks import send_sms
send_sms.delay(from_number, to_number, body, recipient_id=None)
Support
Please open an issue for support.
Contributing
Please contribute using Github Flow. Create a branch, add commits, and open a pull request.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.