https://github.com/dreipol/django-easy-eddie

This Django package sends your text messages (SMS) through Amazon SNS and provides reporting helpers.
https://github.com/dreipol/django-easy-eddie

Last synced: 7 days ago
JSON representation

This Django package sends your text messages (SMS) through Amazon SNS and provides reporting helpers.

• Host: GitHub
• URL: https://github.com/dreipol/django-easy-eddie
• Owner: dreipol
• License: mit
• Created: 2018-02-15T14:09:16.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T20:37:21.000Z (almost 2 years ago)
• Last Synced: 2024-10-13T15:11:44.016Z (about 1 month ago)
• Language: Python
• Size: 23.4 KB
• Stars: 11
• Watchers: 10
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=================

django-easy-eddie

=================

This Django package sends your text messages (SMS) through Amazon SNS and provides reporting helpers.

Sending SMS using the famous boto3 package is easy. Creating usage and billing reports can become tricky especially

if you are using multiple projects on the same AWS account or if you need to split cost in any another way.

Using this package's `send_sms()` function stores an SMS event with the message id in your database and allows you to

fetch meta data (incl. price) through CloudWatch after the submission with a management command. An admin action

allows you to export all events as CSV file.

Quickstart

----------

Install django-easy-eddie::

    pip install django-easy-eddie

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (

        ...

        'easy_eddie',

        ...

    )

Configure settings:

.. code-block:: python

    AWS_DEFAULT_REGION = 'eu-west-1'

    AWS_ACCESS_KEY_ID = 'foo'

    AWS_SECRET_ACCESS_KEY = 'bar'

    EASYEDDIE_CLOUD_WATCH_LOG_GROUP_NAMES = [

        'sns/eu-west-1/000000000000/DirectPublishToPhoneNumber',

        'sns/eu-west-1/000000000000/DirectPublishToPhoneNumber/Failure'

    ]

Migrate your database::

    $ python manage.py migrate easy_eddie

Sending text messages (SMS):

.. code-block:: python

    from easy_eddie.sms import send_sms

    send_sms(sender='your_SNS_sender_id', phone_number='your_phone_number', message='foo')

Fetching CloudWatch logs of unprocessed SMS events:

.. code-block:: python

    from easy_eddie.report_fetchers import fetch_logs_of_unprocessed_sms_events

    fetch_logs_of_unprocessed_sms_events()

Management Command

------------------

This management command can be used to fetch log data from CloudWatch for SMS events. It is probably a good idea to

use it in any scheduled way (e.g. crontab, celery beat, etc.)::

    $ python manage.py fetch_cloud_watch_log_events

AWS CloudWatch

--------------

For more information about setting up CloudWatch logging in AWS, see `Viewing Amazon CloudWatch Metrics and Logs for SMS Deliveries `_

Credits

-------

Tools used in rendering this package:

*  Cookiecutter_

*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

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

Trivia

------

In line with many dreipol projects named after real or fictional characters of the italian mob in america, the name of this package is inspired by Edward `Easy Eddie` J.`O'Hare. ::

    It is believed O'Hare directed investigator Wilson to the Capone bookkeeper who became a key witness at the 1931 trial, and also helped break the code used in the ledgers by Capone's bookkeepers.*

*`Wikipedia `_