Metadata-Version: 1.1
Name: django-followit
Version: 0.2.1
Summary: A Django application that allows users to follow django model objects
Home-page: https://github.com/ASKBOT/django-followit
Author: Evgeny.Fadeev
Author-email: evgeny.fadeev@gmail.com
License: BSD License
Description: The ``followit`` django app allows to easily set up a
        capability for the site users to follow various things on the site,
        represented by django model ``followit.models.FollowRecord`` 
        using the ``django.contrib.models.ContentTypes`` system.
        
        Release Notes
        =============
        Starting the version ``0.2.0``, django-followit supports django 1.8.
        
        Starting the version ``0.1.0``, `django-followit` supports django 1.7.
        Also starting this version, method `register` must be called from your app's
        `AppConfig.ready()` method.
        
        Starting the version ``0.0.8`` it is not necessary to run ``syncdb`` for this app,
        but instead run the ``migrate`` command.
        
        Setup
        ========
        
        To the INSTALLED_APPS in your ``settings.py`` add entry ``'followit'``.
        Run `python manage.py migrate followit`
        
        Then, in the body of `AppConfig.ready` method, add::
            import followit
            followit.register(Thing)
        
        Not it will be possible for the user to follow instances of ``SomeModel``.
        
        If you decide to allow following another model, just add another
        ``followit.register(...)`` statement.
        
        Usage
        ============
        
        Examples below show how to use ``followit`` (assuming that model ``Thing``
        is registered with ``followit`` in your ``models.py``::
            bob.follow_thing(x)
            bob.unfollow_thing(x)
            things = bob.get_followed_things()
            x_followers = x.get_followers()
        
        Available urls from the `followit/urls.py`::
            /follow/<model_name>/<item_id>/
            {% url follow_object "somemodel" item_id %} #model name lower case
        
            /unfollow/<model_name>/<item_id>/
            {% url unfollow_object "somemodel" item_id %} #lower case model name
        
            /toggle-follow/<model_name>/<item_id>/
            {% url toggle_follow_object "somemodel" item_id %} #lower case model name
        
        
        ``followit`` does not yet provide template tags.
        
Keywords: follow,database,django
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.4
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: JavaScript
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
