<commit_before>=================
django-newsletter
=================

.. image:: https://secure.travis-ci.org/dokterbob/django-newsletter.png?branch=master
    :target: http://travis-ci.org/dokterbob/django-newsletter

Newsletter application for the Django web framework.
----------------------------------------------------

What is it?
===========
Django app for managing multiple mass-mailing lists with both plaintext as
well as HTML templates with rich text widget integration, images and a
smart queueing system all right from the admin interface.

Status
======
We are currently using this package in several large to medium scale
production environments, but it should be considered a permanent work in
progress.

Translations
============
Most if not all strings are available in Dutch, German, French Farsi and English.
Contributions to translations are welcome through `Transifex <http://www.transifex.net/projects/p/django-newsletter/>`_.

.. image:: https://www.transifex.com/projects/p/django-newsletter/resource/django/chart/image_png
    :target: http://www.transifex.net/projects/p/django-newsletter/

Compatibility
=============
Currently, django-newsletter is being tested to run on Python 2.6, 2.7 and the
latest Django 1.4 and 1.5 releases. Apart from tests it *should* be compatible
with Python 2.5 as well.

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

Installation
============
#)  Get it from the Cheese Shop::

	pip install django-newsletter

    **Or** get the latest & greatest from Github and link it to your
    application tree::

	pip install -e git://github.com/dokterbob/django-newsletter.git#egg=django-newsletter

    (In either case it is recommended that you use
    `VirtualEnv <http://pypi.python.org/pypi/virtualenv>`_ in order to
    keep your Python environment somewhat clean.)

#)  Add newsletter and to ``INSTALLED_APPS`` in settings.py and make sure that
    your favourite rich text widget (optional), some Django contrib dependencies,
    `sorl-thumbnail <http://sorl-thumbnail.readthedocs.org/en/latest/installation.html>`_
    and `django-extensions <https://github.com/django-extensions/django-extensions>`_
    (the latter is used for the submission jobs) are there as well::

	INSTALLED_APPS = (
	    'django.contrib.contenttypes',
	    'django.contrib.sessions',
	    'django.contrib.auth',
	    'django.contrib.sites',
	    ...
	    # Imperavi (or tinymce) rich text editor is optional
	    'imperavi',
	    'django_extensions',
	    'sorl.thumbnail',
	    ...
	    'newsletter',
	    ...
	)

#)  Install and configure your preferred rich text widget (optional).

    Known to work are `django-imperavi <http://pypi.python.org/pypi/django-imperavi>`_
    as well as for `django-tinymce <http://pypi.python.org/pypi/django-tinymce>`_.
    Be sure to follow installation instructions for respective widgets. After<commit_msg>Document NEWSLETTER_CONFIRM_EMAIL... settings<commit_after>=================
django-newsletter
=================

.. image:: https://secure.travis-ci.org/dokterbob/django-newsletter.png?branch=master
    :target: http://travis-ci.org/dokterbob/django-newsletter

Newsletter application for the Django web framework.
----------------------------------------------------

What is it?
===========
Django app for managing multiple mass-mailing lists with both plaintext as
well as HTML templates with rich text widget integration, images and a
smart queueing system all right from the admin interface.

Status
======
We are currently using this package in several large to medium scale
production environments, but it should be considered a permanent work in
progress.

Translations
============
Most if not all strings are available in Dutch, German, French Farsi and English.
Contributions to translations are welcome through `Transifex <http://www.transifex.net/projects/p/django-newsletter/>`_.

.. image:: https://www.transifex.com/projects/p/django-newsletter/resource/django/chart/image_png
    :target: http://www.transifex.net/projects/p/django-newsletter/

Compatibility
=============
Currently, django-newsletter is being tested to run on Python 2.6, 2.7 and the
latest Django 1.4 and 1.5 releases. Apart from tests it *should* be compatible
with Python 2.5 as well.

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

Installation
============
#)  Get it from the Cheese Shop::

	pip install django-newsletter

    **Or** get the latest & greatest from Github and link it to your
    application tree::

	pip install -e git://github.com/dokterbob/django-newsletter.git#egg=django-newsletter

    (In either case it is recommended that you use
    `VirtualEnv <http://pypi.python.org/pypi/virtualenv>`_ in order to
    keep your Python environment somewhat clean.)

#)  Add newsletter and to ``INSTALLED_APPS`` in settings.py and make sure that
    your favourite rich text widget (optional), some Django contrib dependencies,
    `sorl-thumbnail <http://sorl-thumbnail.readthedocs.org/en/latest/installation.html>`_
    and `django-extensions <https://github.com/django-extensions/django-extensions>`_
    (the latter is used for the submission jobs) are there as well::

	INSTALLED_APPS = (
	    'django.contrib.contenttypes',
	    'django.contrib.sessions',
	    'django.contrib.auth',
	    'django.contrib.sites',
	    ...
	    # Imperavi (or tinymce) rich text editor is optional
	    'imperavi',
	    'django_extensions',
	    'sorl.thumbnail',
	    ...
	    'newsletter',
	    ...
	)

#)  Disable email confirmation for subscribe, unsubscribe and update actions
    for subscriptions.

    By default subscribe, unsubscribe and update requests made by a user who is
    not logged in need to be confirmed by clicking on an activation link in an
    email. If you want all requested actions to be performed without email
    confirmation, add following line to settings.py::

	NEWSLETTER_CONFIRM_EMAIL = False

    For more granular control the ``NEWSLETTER_CONFIRM_EMAIL`` setting can be
    overridden for each of subscribe, unsubscribe and update actions, by adding
    ``NEWSLETTER_CONFIRM_EMAIL_SUBSCRIBE`` and/or
    ``NEWSLETTER_CONFIRM_EMAIL_UNSUBSCRIBE`` and/or
    ``NEWSLETTER_CONFIRM_EMAIL_UPDATE`` set to ``True`` or ``False``.

#)  Install and configure your preferred rich text widget (optional).

    Known to work are `django-imperavi <http://pypi.python.org/pypi/django-imperavi>`_
    as well as for `django-tinymce <http://pypi.python.org/pypi/django-tinymce>`_.
    Be sure to follow installation instructions for respective widgets. After
{'fraction_non_alphanumeric': 0.13152492668621701, 'fraction_numerical': 0.002932551319648094, 'mean_word_length': 3.76659678546471, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 17, 'https://': 6, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2578127', 'n_tokens_mistral': 2015, 'n_tokens_neox': 1900, 'n_words': 648}