Package: django-userproperty
# Django Userproperty[![Build Status](https://travis-ci.org/arteria/django-userproperty.svg?branch=master)](https://travis-ci.org/arteria/django-userproperty)[![Coverage Status](https://coveralls.io/repos/arteria/django-userproperty/badge.svg?branch=master&service=github)](https://coveralls.io/github/arteria/django-userproperty?branch=master)[![PyPI](https://img.shields.io/pypi/v/django-userproperty.svg)](https://pypi.python.org/pypi/django-userproperty)django-userproperty is a reusable Django app that manages per user and global properties. In addition, django-userproperty provides helper functions to set, get, incerement and decrement these properties.## InstallationInstall the package:pip install django-userpropertyAdd the app in you settings.py:INSTALLED_APPS = ('userproperty',)Update your root urls.py file:...url(r'^properties/', include('userproperty.urls')),...And finally sync your dbpython manage.py syncdb## Usage### API for asynchronous UsageThis app is designed to be used with JavaScript/jQuery and asynchronous requests. It provides so besic API interfaces to get and set Properties#### `get-uproperty`> logged-in user is required**name**: name of the user-propertydefault: default value, will be retuned if user-property not found$.get("/get-uproperty/?name=<name>&default=<value>", function(data) {alert(data);});response:{"status": "success", "number-of-items": "50"} // or 100 if the property number-of-items was not found#### `set-uproperty`> logged-in user is required**name**: name of the user-property**value**: value of the user-property to set$.get("/set-uproperty/?name=<name>&value=<value>", function(data) {alert(data);});response:{"status": "success", "number-of-items": "100"}#### `get-gproperty`> staff member is required**name**: name of the global-propertydefault: default value, will be retuned if global-property not found$.get("/get-gproperty/?name=<name>&default=<value>", function(data) {alert(data);});response:{"status": "success", "number-of-items": "50"}#### `set-gproperty` - staff member is required> staff member is required**name**: name of the global-property**value**: value of the global-property to set$.get("/set-gproperty/?name=<name>&value=<value>", function(data) {alert(data);});returns{"status": "success", "number-of-items": "100"}### More examples:After creating an account on your website, the user needs to do some tasks before he can enter his profile. In this example adding more information and agreeing to the terms and conditions.When creating the new user you create a new property:from userproperty.utils import addPropertyaddProperty(request, tag='setup')# if the user is not saved in the request add: anUser=yourNewUserIn your login view you can now have different outcomes based on the UserPropertyfrom userproperty.utils import getIntegerProperty, setIntegerProperty, removeProperty#in your login viewsetupProperty = getIntegerProperty(request,'setup')if setupProperty == 1:#redirect, a form for adding phone number etcelif setupProperty == 2:#redirect, accepting the terms and conditionselif setupProperty:removeProperty(request, tag='setup')# stuff when no property was setThe only thing left to do is setting the property to a new value when the respective actions(forms in this case) are done:from userproperty.utils import setIntegerProperty, removeProperty#in the view with the form for the phonenumer etc.form.is_valid():#do stuffsetIntegerProperty(request, tag='setup', value=2)#redirect login#in the view for terms and conditionsform.is_valid():#do stuffremoveProperty(request, tag='setup')#redirect loginOther examples: setup tour, saving user specific properties(number of data entries displayed in js datatables), etc.## PEP8The functions are available in pep8 (lowercase with _ as separator between words)setIntegerProperty() ==> set_integer_property()## Change Log### 06/Aug/2015* Propper anonymous users handling.* ``decUserProperty`` and ``incUserProperty`` returns ``False`` instead of ``True`` for anonymous users or in case of errors.