django-rest-friendship 0.1.0

DRF endpoints for django-friendship

Overview

DRF endpoints for django-friendship

Requirements

• Python (2.7, 3.5, 3.6)

• Django (1.9, 1.10, 1.11)

• Django REST Framework (3.6)

Installation

Install using pip…

$ pip install django-rest-friendship

Add rest_friendship to your INSTALLED_APPS

INSTALLED_APPS = (
...
'friendship',  # Django friendship
'rest_framework',  # Django REST Framework
'rest_friendship',  # Django REST Friendship
'rest_framework.authtoken',
...
)

Example

TODO: Write example.

Testing

Install testing requirements.

$ pip install -r requirements.txt

Run with runtests.

$ ./runtests.py

You can also use the excellent tox testing tool to run the tests against all supported versions of Python and Django. Install tox globally, and then simply run:

$ tox

Documentation

To build the documentation, you’ll need to install mkdocs.

$ pip install mkdocs

To preview the documentation:

$ mkdocs serve
Running at: http://127.0.0.1:8000/

To build the documentation:

$ mkdocs build