https://github.com/ulule/django-courriers

A generic application to manage your newsletters
https://github.com/ulule/django-courriers

Last synced: 3 months ago
JSON representation

A generic application to manage your newsletters

• Host: GitHub
• URL: https://github.com/ulule/django-courriers
• Owner: ulule
• License: mit
• Created: 2013-10-22T09:41:04.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-02-23T21:50:40.000Z (over 2 years ago)
• Last Synced: 2024-03-18T19:13:39.612Z (3 months ago)
• Language: Python
• Size: 241 KB
• Stars: 85
• Watchers: 14
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Lists

• my-awesome-starred - django-courriers - A generic application to manage your newsletters (Python)
• starred-awesome - django-courriers - A generic application to manage your newsletters (Python)

README

        
django-courriers

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

.. image:: https://secure.travis-ci.org/ulule/django-courriers.png?branch=master

    :alt: Build Status

    :target: http://travis-ci.org/ulule/django-courriers

A generic application to manage your newsletters

What it does?

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

django-courriers has four models:

- ``NewsletterList`` which represents a newsletter list

- ``Newsletter`` which represents a newsletter

- ``NewsletterItem`` an item of a newsletter. It could be a content-type

- ``NewsletterSubscriber`` which represents a user who is subscribed to a newsletter

You have the choice between two backends to manage and send your emails:

- ``SimpleBackend``, a simple backend to send emails with Django and

  your current smtp configuration

- ``MailJetBackend``, a `Mailjet`_ backend which uses `mailjet library`_

Installation

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

1. Download the package on GitHub_ or simply install it via PyPi

2. Add ``courriers`` to your ``INSTALLED_APPS`` ::

    INSTALLED_APPS = (

        'courriers',

    )

3. Sync your database using ``syncdb`` command from django command line

4. Configure settings

You have to specify which backend you want to use in your settings ::

    COURRIERS_BACKEND_CLASS = 'courriers.backends.simple.SimpleBackend'

A quick reminder: you can also set your custom ``DEFAULT_FROM_EMAIL`` in Django settings.

Backends

--------

courriers.backends.simple.SimpleBackend

........................................

A simple backend to send your emails with Django and

your current smtp configuration

courriers.backends.mailjet.MailjetBackend

..............................................

A backend to manage your newsletters with Mailjet.

What you need to do for mailjet

.................................

- Create an account on Mailjet

- Get your API key and API Secret key

- Add it to your settings with others options as described below

- Install the `mailjet library`_

- Create a list or more if you have users

  from different countries

With this backend you have to provide additional settings ::

    COURRIERS_MAILJET_API_KEY = 'Your API key'

    COURRIERS_MAILJET_API_SECRET_KEY = 'Your API Secret key'

    COURRIERS_DEFAULT_FROM_NAME = 'Your name'

.. _GitHub: https://github.com/ulule/django-courriers

.. _Mailjet: https://eu.mailjet.com/

.. _mailjet library: https://pypi.python.org/pypi/mailjet/