Metadata-Version: 1.1
Name: django-friendship
Version: 1.0.0
Summary: django-friendship provides an easy extensible interface for following and friendship
Home-page: https://github.com/revsys/django-friendship/
Author: Frank Wiles
Author-email: frank@revsys.com
License: UNKNOWN
Description: django-friendship
        =================
        
        .. image:: https://secure.travis-ci.org/revsys/django-friendship.png
            :alt: Build Status
            :target: http://travis-ci.org/revsys/django-friendship
        
        Usage
        =====
        
        Add ``friendship`` to ``INSTALLED_APPS`` and run ``syncdb``.
        
        To use ``django-friendship`` in your views::
        
            from django.contrib.auth.models import User
            from friendship.models import Friend, Follow
        
            def my_view(request):
                # List of this user's friends
                all_friends = Friend.objects.friends(request.user)
        
                # List all unread friendship requests
                requests = Friend.objects.unread_requests(user=request.user)
        
                # List all rejected friendship requests
                rejects = Friend.objects.rejected_requests(user=request.user)
        
                # List all sent friendship requests
                sent = Friend.objects.sent_requests(user=request.user)
        
                # List of this user's followers
                all_followers = Following.objects.followers(request.user)
        
                # List of who this user is following
                following = Following.objects.following(request.user)
        
                ### Managing friendship relationships
                other_user = User.objects.get(pk=1)
                new_relationship = Friend.objects.add_friend(request.user, other_user)
                Friend.objects.are_friends(request.user, other_user) == True
                Friend.objects.remove_friend(other_user, request.user)
        
                # Create request.user follows other_user relationship
                following_created = Following.objects.add_follower(request.user, other_user)
        
        To use ``django-friendship`` in your templates::
        
           {% load friendshiptags %}
        
           {% friends request.user %}
           {% followers request.user %}
           {% following request.user %}
           {% friend_requests request.user %}
        
        Signals
        =======
        
        ``django-friendship`` emits the following signals:
        
        * friendship_request_created
        * friendship_request_rejected
        * friendship_request_canceled
        * friendship_request_accepted
        * friendship_removed
        * follower_created
        * following_created
        * follower_removed
        * following_removed
        
        Compatibility
        =============
        
        This package requires Django 1.4 since v0.9.0. The last release supporting Django 1.3 is v0.8.3.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Framework :: Django
