Reference¶
Everything the library offers, listed. The guide explains how the parts fit; this section is for looking one up.
Configuration¶
| page | what is there |
|---|---|
| Settings | every key of CLEARANCE, with its default |
The ACCESS file |
bundles, status actions and roles written as code |
| System checks | every clearance.E0xx, and what it refuses at start-up |
| Management commands | clearance_sync and clearance_check, with their options |
| Signals | every change to access, announced - and what each carries |
| Models | the tables the library keeps |
| Template tags | {% load clearance %} |
Python API¶
Read from the code itself, so it never falls behind it. The descriptions are the code's own, in English.
| page | what is there |
|---|---|
| Permissions | build_permissions, permission_for |
| Row scopes | ScopedQuerySet, OwnedQuerySet, SignedInReadQuerySet, visible |
| Policies | BasePolicy, ModelPolicy, the registry |
| Services | AccessService - every change to access |
| Fields and values | protected fields, status actions, writes within scope |
| Views | Django's views and the decorator |
| Django REST framework | permissions, serializers, viewsets |
| The admin site | ClearanceAdminSite |
| Roles | RoleService, the resolvers, has_role |
| Names | label_of, labels_in, TranslationService |
| Extending it | the limits a layer above bundles installs, and the user protocol |