Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
An email newsletter application for the Django web application framework, including an extended admin interface, web (un)subscription, dynamic e-mail templates, an archive and HTML email support.
Python Makefile Shell

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
newsletter
seleniumtests
.gitignore
COPYRIGHT
LICENSE
MANIFEST.in
README.rst
distribute_setup.py
django-newsletter.tmproj
graph_models.dot
graph_models.png
requirements.txt
setup.py

README.rst

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 for an updated list of required packes.

Installation

  1. Install the package using pip install -e git://github.com/dokterbob/django-newsletter.git#egg=django_newsletter

  2. ln -s <my_project>/<media_dir> <newsletter_install_dir>/media

  3. Add newsletter to INSTALLED_APPS in settings.py

  4. 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)

  5. Run unit tests just to be sure it is working: ./manage.py test newsletter.

  6. If it is not, let me know. Create an issue on GitHub or send me a message.

Usage

  1. Load up default newsletter template fixtures: ./manage.py loaddata default_templates
  2. Start the development server: ./manage.py runserver
  3. Navigate to /admin/ and: behold!
  4. Put a submission in the queue.
  5. Submit your message with ./manage.py runjob submit
  6. For a proper understanding, please take a look at the model graph.
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.

Something went wrong with that request. Please try again.