Skip to content

Latest commit

 

History

History
56 lines (47 loc) · 1.98 KB

README.rst

File metadata and controls

56 lines (47 loc) · 1.98 KB
Raw

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. Run unit tests just to be sure it is working: ./manage.py test newsletter.
  5. If it is not, let me know. Create an issue on GitHub or send me a message.

Usage

  1. Start the development server: ./manage.py runserver
  2. Navigate to /admin/ and: behold!
  3. Put a submission in the queue.
  4. Submit your message with ./manage.py runjob submit
  5. 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.

License

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