Metadata-Version: 1.0
Name: django-subscribe
Version: 0.1.4
Summary: A simple subscription app for Django. Allows a user to subscribe to any object.

Home-page: https://github.com/bitmazk/django-subscribe
Author: Martin Brochhaus
Author-email: mbrochh@gmail.com
License: The MIT License
Description: Django Subscribe 
        ================
        
        A simple subscription app for Django.
        
        TODO: Add more info
        
        
        Installation
        ------------
        
        Prerequisites:
        
        * Django
        
        If you want to install the latest stable release from PyPi::
        
            $ pip install django-subscribe
        
        If you feel adventurous and want to install the latest commit from GitHub::
        
            $ pip install -e git://github.com/bitmazk/django-subscribe.git#egg=subscribe
        
        Add ``subscribe`` to your ``INSTALLED_APPS``::
        
            INSTALLED_APPS = (
                ...,
                'subscribe',
            )
        
        Run the South migrations::
        
            ./manage.py migrate subscribe
        
        
        Usage
        -----
        
        In order to render a subscribe/unsubscribe button next to an object, do this::
        
            {% load i18n subscribe_tags %}
            {% get_subscribers object as subscribers %}
            {% get_ctype object as ctype %}
            {% is_subscribed user object as user_is_subscribed %}
            {% if user_is_subscribed %}
                <p><a href="{% url "subscriptions_delete" ctype_pk=ctype.pk object_pk=object.pk %}">{% trans "Un-subscribe" %}</a></p>
            {% else %}
                <p><a href="{% url "subscriptions_create" ctype_pk=ctype.pk object_pk=object.pk %}">{% trans "Subscribe" %}</a></p>
            {% endif %}
        
        Roadmap
        -------
        
        Check the issue tracker on github for milestones and features to come.
        
Keywords: django,subsription,generic
Platform: OS Independent
