Simplify how urlpatterns are loaded

Author: Jaap Roes

AUTHORS

@@ -62,6 +62,7 @@ Hiroki Kiyohara
 Hossein Shakiba
 Islam Kamel
 Ivan Lukyanets
+Jaap Roes
 Jadiel Teófilo
 Jens Timmerman
 Jerome Leclanche

README.rst

@@ -65,13 +65,14 @@ Add ``oauth2_provider`` to your ``INSTALLED_APPS``
 
 
 If you need an OAuth2 provider you'll want to add the following to your ``urls.py``.
-Notice that ``oauth2_provider`` namespace is mandatory.
 
 .. code-block:: python
 
+    from oauth2_provider import urls as oauth2_urls
+
     urlpatterns = [
         ...
-        path('o/', include('oauth2_provider.urls', namespace='oauth2_provider')),
+        path('o/', include(oauth2_urls)),
     ]
 
 Changelog

docs/getting_started.rst

@@ -191,10 +191,11 @@ Include ``oauth2_provider.urls`` to :file:`iam/urls.py` as follows:
 
     from django.contrib import admin
     from django.urls import include, path
+    from oauth2_provider import urls as oauth2_urls
 
     urlpatterns = [
         path('admin/', admin.site.urls),
-        path('o/', include('oauth2_provider.urls', namespace='oauth2_provider')),
+        path('o/', include(oauth2_urls)),
     ]
 
 This will make available endpoints to authorize, generate token and create OAuth applications.

docs/install.rst

@@ -20,10 +20,11 @@ If you need an OAuth2 provider you'll want to add the following to your :file:`u
 .. code-block:: python
 
     from django.urls import include, path
+    from oauth2_provider import urls as oauth2_urls
 
     urlpatterns = [
         ...
-        path('o/', include('oauth2_provider.urls', namespace='oauth2_provider')),
+        path('o/', include(oauth2_urls),
     ]
 
 Sync your database

docs/rest-framework/getting_started.rst

@@ -51,6 +51,7 @@ Here's our project's root :file:`urls.py` module:
 
     from rest_framework import generics, permissions, serializers
 
+    from oauth2_provider import urls as oauth2_urls
     from oauth2_provider.contrib.rest_framework import TokenHasReadWriteScope, TokenHasScope
 
     # first we define the serializers
@@ -84,7 +85,7 @@ Here's our project's root :file:`urls.py` module:
     # Setup the URLs and include login URLs for the browsable API.
     urlpatterns = [
         path('admin/', admin.site.urls),
-        path('o/', include('oauth2_provider.urls', namespace='oauth2_provider')),
+        path('o/', include(oauth2_urls)),
         path('users/', UserList.as_view()),
         path('users/<pk>/', UserDetails.as_view()),
         path('groups/', GroupList.as_view()),

docs/tutorial/tutorial_01.rst

@@ -34,10 +34,11 @@ Include the Django OAuth Toolkit urls in your `urls.py`, choosing the urlspace y
 .. code-block:: python
 
     from django.urls import path, include
+    from oauth2_provider import urls as oauth2_urls
 
     urlpatterns = [
         path("admin", admin.site.urls),
-        path("o/", include('oauth2_provider.urls', namespace='oauth2_provider')),
+        path("o/", include(oauth2_urls)),
         # ...
     ]
 

tests/urls.py

@@ -1,11 +1,13 @@
 from django.contrib import admin
 from django.urls import include, path
 
+from oauth2_provider import urls as oauth2_urls
+
 
 admin.autodiscover()
 
 
 urlpatterns = [
-    path("o/", include("oauth2_provider.urls", namespace="oauth2_provider")),
+    path("o/", include(oauth2_urls)),
     path("admin/", admin.site.urls),
 ]