drfobserver 0.1.0

Django Rest Framework object observer pattern

Overview

Django Rest Framework object observer pattern

Requirements

• Python (2.7, 3.3, 3.4)
• Django (1.6, 1.7, 1.8)
• Django REST Framework (2.4, 3.0, 3.1)

Installation

Install using pip…

$ pip install drfobserver

Example

from django.db import models
from drfobserver import ObserverMixin, observer

class Actor(ObserverMixin, models.Model,):
    """ Actor model """

    first_name = models.CharField(max_length=50)
    last_name = models.CharField(max_length=50)

    @observer('first_name', 'last_name')
    def _setter_name(self):
        """ Set the full name from first & last """

        self.name = '%s %s' % (self.first_name, self.last_name)

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