django-friendship 1.8.0

Django-Friendship

This application enables you to create and manage follows, blocks and bi-directional friendships between users. It features:

• Friendship request objects that can be accepted, rejected, canceled, or marked as viewed.

• Hooks to easily list all friend requests sent or received by a given user, filtered by the status of the request.

• A blocklist for each user of users they’ve blocked.

• Tags to include information about friendships, blocks and follows in your templates.

• Integration with AUTH_USER_MODEL.

• Validation to prevent common mistakes.

• Faster server response time through caching

Requirements

Django 1.11+ since v1.7.0 (latest release supporting Django 1.10 is v1.6.0)

Installation

1. pip install django-friendship

2. add "friendship" to INSTALLED_APPS and run python manage.py migrate.

3. Use the friendship manager in your own views, or wire up the URLconf to include the builtin views:

   urlpatterns = [
       ...
       url(r'^friendship/', include('friendship.urls'))
       ...
   ]

Note: If you are migrating from django-friendship v1.6.x, you’ll need to rollback your migrations and fake migration 0002

$ ./manage.py migrate friendship 0001
$ ./manage.py migrate friendship 0002 --fake

If you’re migrating from v1.7.x, you’ll likely have to fake 0003 as well:

$ ./manage.py migrate friendship 0003 --fake

Usage

django-friendship provides a free API that gives you several ways to create and manage friendship requests or follows in your views. Add the following at the top of your views.py:

from django.contrib.auth.models import User
from friendship.models import Friend, Follow, Block

Templates

You can use django-friendship tags in your templates. First enter: :

{% load friendshiptags %}

Then use any of the following: :

{% friends request.user %}
{% followers request.user %}
{% following request.user %}
{% friend_requests request.user %}
{% blockers request.user %}
{% blocking 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

• block_created

• block_removed

Contributing

Development takes place on GitHub. Bug reports, patches, and fixes are always welcome!