Metadata-Version: 1.0
Name: django-permission
Version: 0.2.0
Summary: A enhanced permission system which enable object permission
Home-page: https://github.com/lambdalisue/django-permission
Author: Alisue
Author-email: lambdalisue@hashnote.net
License: MIT
Download-URL: https://github.com/lambdalisue/django-permission/tarball/master
Description: **********************************
         djagno-permission
        **********************************
        
        django-permission is an enhanced permission system which support object permission and role based permission system.
        
        
        Install
        ==============
        django-permission is in PyPI_ so::
        
            $ pip install django-permission
        
            or
        
            $ pip install git+git://github.com/lambdalisue/django-permission.git#egg=django-permission
        
        Quick tutorial
        ============================
        
        1.  Add ``'permission'`` to ``INSTALLED_APPS`` of your ``settings.py`` and confirm
            ''django.contrib.auth' and 'django.contrib.contenttypes' is in ``INSTALLED_APPS``
        
            .. Note::
                django-permission can use `django-fenicms <https://github.com/matiasb/fenics>`_ to improve
                the visual design of change_list page in django admin if available. Add 'fenicms' to
                your ``INSTALLED_APPS`` to enable AJAX sorting, adding, expanding features.
        
        2.  Add ``'permission.backends.PermissionBackend'`` to ``AUTHENTICATION_BACKENDS``
            of your ``settings.py``. If you cannot existing settings, simply add 
            following code::
        
                AUTHENTICATION_BACKENDS = (
                    #'django.contrib.auth.backends.ModelBackend',   # Do not use this backend with RoleBackend
                    'permission.backends.ModelBackend',             # use permission.backends.ModelBackend insted
                    'permission.backends.PermissionBackend',
                    'permission.backends.RoleBackend',
                )
        
        3.  Add ``permissions.py`` to the directory which contains ``models.py``. And
            write following codes for starting::
        
                from permission import registry
                from permission import PermissionHandler
        
                from models import YourModel
        
                class YourModelPermissionHandler(PermissionHandler):
                    """Permission handler class for ``YourModel``. Similar with AdminSite"""
                    def has_perm(self, user_obj, perm, obj=None):
                        """this is called for checking permission of the model."""
                        if user_obj.is_authenticated():
                            if perm == 'yourapp.add_yourmodel':
                                # Authenticated user has add permissions of this model
                                return True
                            elif obj and obj.author == user_obj:
                                # Otherwise (change/delete) user must be an author
                                return True
                        # User doesn't have permission of ``perm``
                        return False
        
                # register this ``YourModelPermissionHandler`` with ``YourModel``
                registry.register(YourModel, YourModelPermissionHandler)
        
        Role?
        ==========
        
        django-permission has role based permission system. visit your django admin page to create/modify roles (See the screenshots below).
        The role permissions are handled with ``permission.backends.RoleBackend``.
        
        .. image:: http://s1-01.twitpicproxy.com/photos/full/528601159.png?key=943727
            :align: center
        
        .. image:: http://s1-04.twitpicproxy.com/photos/full/528601385.png?key=9431458
            :align: center
        
        This role system is under development. This system might not work correctly yet.
        
        .. Note::
            Role based permission system does not support object permission and anonymous permission. 
            However these permissions are handled with Individual handler based permission backend
            (``permission.backends.PermissionBackend``)
        
        
        How to regulate permissions used in the handler
        ==============================================================================================
        
        ``PermissionHandler`` care permissions related with registered model only in default. To change
        this behavior, you must define ``permissions`` attribute or ``get_permissions`` methods which
        return a permission string (like 'auth.add_user') list.
        
        ``get_permissions`` return the value of ``permissions`` if the attribute is defined. Otherwise it
        return all permissions related to the model in default used ``get_model_permissions`` method.
        
        The sample code below show how to handle all permissions of the app of the model in one
        ``PermissionHandler``::
        
            from permission import registry
            from permission import PermissionHandler
        
            from models import YourModel
            from models import HisModel
            from models import HerModel
        
            class AppPermissionHandler(PermissionHandler):
                def get_permissions(self):
                    # ``get_app_permissions()`` method return all permissions related
                    # to the app of the model.
                    return self.get_app_permissions()
        
                def has_perm(self, user_obj, perm, obj=None):
                    if perm.endswith('_yourmodel'):
                        # All user has all permissions for ``YourModel``
                        return True
                    elif perm.endswith('_hismodel'):
                        if user_obj.is_authenticated():
                            # only authenticated user has all permissions for ``HisModel``
                            return True
                    elif perm.endswith('_hermodel'):
                        if user_obj.is_staff:
                            # only staff user has all permissions for ``HerModel``
                            return True
                    return False
        
            # you have to register the handler with the model
            # even AppPermissionHandler doesn't care about model
            registry.register(YourModel, AppPermissionHandler)
            # registry.register(HisModel, AppPermissionHandler) # or you can register with HisModel
            # registry.register(HerModel, AppPermissionHandler) # or you can register with HerModel
            
        
Keywords: django permisssion auth
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP
