mirror of
https://github.com/jazzband/django-authority.git
synced 2026-05-15 19:13:12 +00:00
77 lines
No EOL
2 KiB
Text
77 lines
No EOL
2 KiB
Text
.. django-authority documentation master file, created by
|
|
|
|
============================================
|
|
Welcome to django-authority's documentation!
|
|
============================================
|
|
|
|
django-authority is a powerful layer between Django's basic permission system
|
|
(provided through ``django.contrib.auth``) and your application:
|
|
|
|
.. image:: .static/authority-scheme-layer.png
|
|
|
|
Summarized this application provides three abilities:
|
|
|
|
1. It gives you the ability to add permissions like Django's generic permissions
|
|
to any kind of model without storing them in the model's META attribute.
|
|
|
|
2. It provides a very simple way to create per-object-permissions. You might
|
|
be more familiar with the term *row level permissions*.
|
|
|
|
3. It wraps Django's generic permissions so you can use the same syntax as
|
|
for the above ones. But note that django-authority does not add any
|
|
voodoo-code to Django's ``contrib.auth`` system so your existing permission
|
|
system keeps intact!
|
|
|
|
.. warning:: We have just started with the documentation and it's far from
|
|
being perfect. If you found glitches, errors or just have feedback, please
|
|
contact the team: :ref:`team_and_support`.
|
|
|
|
Documentation
|
|
=============
|
|
|
|
.. note:: The create-permission topics are based on each other. If you are new
|
|
to django-authority we encourage to read from top to bottom.
|
|
|
|
**Installation topics:**
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
installation
|
|
configuration
|
|
|
|
**Create and check permissions:**
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
permission_create_basic
|
|
permission_create_per_object
|
|
permission_create_custom
|
|
|
|
**Permission checks in detail**
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
permission_check_python
|
|
permission_check_decorator
|
|
permission_check_in_templates
|
|
|
|
**Permission assigning and handling**
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
|
|
permission_python_handling
|
|
permission_admin_handling
|
|
permission_template_handling
|
|
|
|
Other pages
|
|
===========
|
|
|
|
* :ref:`search`
|
|
|
|
.. * :ref:`genindex`
|
|
.. * :ref:`modindex` |