Hopiu/django-axes
1
0
Fork 0
mirror of https://github.com/jazzband/django-axes.git synced 2026-05-16 11:33:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update DRF documentation

Browse source 
Update old version information and clean up summary table
This commit is contained in:
Aleksi Häkli 2021-01-05 10:44:06 +02:00 committed by GitHub
parent 9ccb6e472e
commit 419478b954
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/6_integration.rst
View file

@ -9,14 +9,13 @@ such as Django Allauth, Django REST Framework, and other tools.
In the following table
**Compatible** means that a component should be fully compatible out-of-the-box,
**Functional** means that a component should be functional after customization, and
**Functional** means that a component should be functional after configuration, and
**Incompatible** means that a component has been reported as non-functional with Axes.
======================= ============= ============ ============ ==============
Project Version Compatible Functional Incompatible
======================= ============= ============ ============ ==============
Django REST Framework |gte| 3.7.0 |check|
Django REST Framework |lt| 3.7.0 |check|
Django REST Framework |check|
Django Allauth |check|
Django Simple Captcha |check|
Django OAuth Toolkit |check|
@ -99,10 +98,6 @@ You also need to decorate ``dispatch()`` and ``form_invalid()`` methods of the A
Integration with Django REST Framework
--------------------------------------
.. note::
DRF versions prior to 3.7.0 will not function properly.
Django Axes requires REST Framework to be connected
via lockout signals for correct functionality.
@ -113,6 +108,7 @@ You can use the following snippet in your project signals such as ``example/sign
from axes.signals import user_locked_out
from rest_framework.exceptions import PermissionDenied
@receiver(user_locked_out)
def raise_permission_denied(*args, **kwargs):
raise PermissionDenied("Too many failed login attempts")