From 419478b954b07cebb6ead85506e6ab0d6c504b2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksi=20H=C3=A4kli?= Date: Tue, 5 Jan 2021 10:44:06 +0200 Subject: [PATCH] Update DRF documentation Update old version information and clean up summary table --- docs/6_integration.rst | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/docs/6_integration.rst b/docs/6_integration.rst index 54ff8e6..1baa838 100644 --- a/docs/6_integration.rst +++ b/docs/6_integration.rst @@ -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")