<commit_before>.. _index:

============================================
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

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 having to add them to the model's
   Meta class.

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 options above. But note that django-authority does not add any
   voodoo-code to Django's ``contrib.auth`` system, it keeps your existing
   permission system intact!

.. warning:: We have just started with the documentation and it's far from
   being perfect. If you find glitches, errors or just have feedback, please
   contact the team: :ref:`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.
<commit_msg>refs #9: added a line in the basic overview about the smart cache<commit_after>.. _index:

============================================
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

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 having to add them to the model's
   Meta class.

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 options above. But note that django-authority does not add any
   voodoo-code to Django's ``contrib.auth`` system, it keeps your existing
   permission system intact!

django-authority uses a cache that is stored on the user object to help improve
performance. However, if the ``Permission`` table changes the cache will need
to be invalidated. More information about this can be found in the tips and
tricks section.

.. warning:: We have just started with the documentation and it's far from
   being perfect. If you find glitches, errors or just have feedback, please
   contact the team: :ref:`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.

{'fraction_non_alphanumeric': 0.12351945854483926, 'fraction_numerical': 0.0023688663282571912, 'mean_word_length': 4.364791288566243, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7506802', 'n_tokens_mistral': 726, 'n_tokens_neox': 691, 'n_words': 389}