Skip to main content

Django app for managing multiple mass-mailing lists with both plaintext as well as HTML templates (and TinyMCE editor for HTML messages), images and a smart queueing system all right from the admin interface.

Project description

=================
django-newsletter
=================

What is it?
-----------
Django app for managing multiple mass-mailing lists with both plaintext as
well as HTML templates (and TinyMCE editor for HTML messages), images and a
smart queueing system all right from the admin interface.

Status
------
We are currently using this package in several production environments, but it
should still be considered a work in progress.

Requirements
------------
Please refere to `requirements.txt <http://github.com/dokterbob/django-newsletter/blob/master/requirements.txt>`_ for an updated list of required packes.

Installation
------------
#) Install the package using ``pip install -e git://github.com/dokterbob/django-newsletter.git#egg=django_newsletter``
#) ``ln -s <my_project>/<media_dir> <newsletter_install_dir>/media``
#) Add ``newsletter`` to ``INSTALLED_APPS`` in ``settings.py``
#) Make sure dependency ``tinymce`` is in ``INSTALLED_APPS`` and configure
``TINYMCE_JS_URL`` to point to wherever ``tiny_mce.js`` is located.
(Typically ``/media/tinymce/tiny_mce/tiny_mce.js``)
#) Run unit tests just to be sure it is working: ``./manage.py test newsletter``.
#) If it is not, let me know. Create an issue on GitHub or send me a message.

Usage
-----
#) Load up default newsletter template fixtures: ``./manage.py loaddata default_templates``
#) Start the development server: ``./manage.py runserver``
#) Navigate to ``/admin/`` and: behold!
#) Put a submission in the queue.
#) Submit your message with ``./manage.py runjob submit``
#) For a proper understanding, please take a look at the model graph.

.. image:: http://github.com/dokterbob/django-newsletter/raw/master/graph_models.png

Unit tests
----------
Fairly extensive tests are available for internal frameworks, web
(un)subscription and mail sending. One feature currently untested is actually
sending mail to very large numbers of recipients (1000+), but feel free to try
around.

TODO
----
* Add a separate submission queue view in the admin instead of the modded edit
view, which is confusing to the user.
* Finish front end for article ordering from admin.
* Write tests for: template syntax checking, ordering of articles in a
message.
* Extend subscription models to allow for mail deliverability feedback.

License
-------
This application is released
under the GNU Affero General Public License version 3.

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-newsletter-0.2.tar.gz (182.8 kB view hashes)

Uploaded source

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