Skip to main content

A reusable Django app that protects email addresses, in various ways.

Project description

Django Mailprotector
============

.. image:: https://travis-ci.org/bnzk/django-mailprotector.svg
:target: https://travis-ci.org/bnzk/django-mailprotector


A reusable Django app that protects email addresses, in various ways. Django 1.8+, no further dependencies.

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

To get the latest stable release from PyPi (not yet!)

.. code-block:: bash

pip install django-mailprotector

Add ``mailprotector`` to your ``INSTALLED_APPS``

.. code-block:: python

INSTALLED_APPS = (
...,
'mailprotector',
)


Usage
-----

Before your tags/filters are available in your templates, load them by using

.. code-block:: html

{% load mailprotector_tags %}


Then either email address after email address:

.. code-block:: html

{% mailprotector 'your@domain.com' link_text='link text' css_class='stylish' %}

Or as text block, for example from a rich text editor:

.. code-block:: html

{% mailprotector_textblock object.richtext css_class='stylish' %}


Development
----------

- there is test app, available with `./manage.py runserver`.
- to run tests: ./manage.py test
- to run tests with django 1.8 / 1.9 / 1.10: `tox`


Contribute
----------

If you want to contribute to this project, please perform the following steps

.. code-block:: bash

# Fork this repository
# Clone your fork
mkvirtualenv -p python2.7 django-mailprotector
pip install -r test_requirements.txt
git checkout -b feature_branch
# Implement your feature and tests
git add . && git commit
git push -u origin feature_branch
# Send us a pull request for your feature branch

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-mailprotector-0.1.tar.gz (9.2 kB view hashes)

Uploaded Source

Built Distribution

django_mailprotector-0.1-py2.py3-none-any.whl (12.4 kB view hashes)

Uploaded Python 2 Python 3

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