django-email-obfuscator
=======================

A template filter to mask email addresses from crawlers.
django-email-obfuscator
=======================

A Django template filter to protect email addresses from crawlers.

Installation
------------

Copy the `email_obfuscator` folder into your Django project's root directory.
Then, add `email_obfuscator` to `INSTALLED_APPS` in `settings.py`:

    INSTALLED_APPS = (
        # ...
        'email_obfuscator',
    )

Usage
-----

In your templates, you can protect email addresses with the `obfuscate`
filter:

    {% load email_obfuscator %}
    {{ 'your@email.com'|obfuscate }}

The email address will be encoded with ASCII character entities, protecting it
from spambots but rendering it readably in web browsers.

You can also use the filter to create clickable `mailto` links:

    {% load email_obfuscator %}
    <a href="mailto:{{'your@email.com'}}">Email me</a>

Add installation and usage instructions
Add installation and usage instructions
