mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2024-09-21 11:29:08 +03:00
94269f8c7f
* feat: Add a prefix setting so that swagger tags are generated in a readable way * feat: Change `auth-token` URLs
81 lines
2.7 KiB
Python
81 lines
2.7 KiB
Python
# ruff: noqa
|
|
from django.conf import settings
|
|
from django.conf.urls.static import static
|
|
from django.contrib import admin
|
|
{%- if cookiecutter.use_async == 'y' %}
|
|
from django.contrib.staticfiles.urls import staticfiles_urlpatterns
|
|
{%- endif %}
|
|
from django.urls import include
|
|
from django.urls import path
|
|
from django.views import defaults as default_views
|
|
from django.views.generic import TemplateView
|
|
{%- if cookiecutter.use_drf == 'y' %}
|
|
from drf_spectacular.views import SpectacularAPIView
|
|
from drf_spectacular.views import SpectacularSwaggerView
|
|
from rest_framework.authtoken.views import obtain_auth_token
|
|
{%- endif %}
|
|
|
|
urlpatterns = [
|
|
path("", TemplateView.as_view(template_name="pages/home.html"), name="home"),
|
|
path(
|
|
"about/",
|
|
TemplateView.as_view(template_name="pages/about.html"),
|
|
name="about",
|
|
),
|
|
# Django Admin, use {% raw %}{% url 'admin:index' %}{% endraw %}
|
|
path(settings.ADMIN_URL, admin.site.urls),
|
|
# User management
|
|
path("users/", include("{{ cookiecutter.project_slug }}.users.urls", namespace="users")),
|
|
path("accounts/", include("allauth.urls")),
|
|
# Your stuff: custom urls includes go here
|
|
# ...
|
|
# Media files
|
|
*static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT),
|
|
]
|
|
{%- if cookiecutter.use_async == 'y' %}
|
|
if settings.DEBUG:
|
|
# Static file serving when using Gunicorn + Uvicorn for local web socket development
|
|
urlpatterns += staticfiles_urlpatterns()
|
|
{%- endif %}
|
|
{% if cookiecutter.use_drf == 'y' %}
|
|
# API URLS
|
|
urlpatterns += [
|
|
# API base url
|
|
path("api/", include("config.api_router")),
|
|
# DRF auth token
|
|
path("api/auth-token/", obtain_auth_token),
|
|
path("api/schema/", SpectacularAPIView.as_view(), name="api-schema"),
|
|
path(
|
|
"api/docs/",
|
|
SpectacularSwaggerView.as_view(url_name="api-schema"),
|
|
name="api-docs",
|
|
),
|
|
]
|
|
{%- endif %}
|
|
|
|
if settings.DEBUG:
|
|
# This allows the error pages to be debugged during development, just visit
|
|
# these url in browser to see how these error pages look like.
|
|
urlpatterns += [
|
|
path(
|
|
"400/",
|
|
default_views.bad_request,
|
|
kwargs={"exception": Exception("Bad Request!")},
|
|
),
|
|
path(
|
|
"403/",
|
|
default_views.permission_denied,
|
|
kwargs={"exception": Exception("Permission Denied")},
|
|
),
|
|
path(
|
|
"404/",
|
|
default_views.page_not_found,
|
|
kwargs={"exception": Exception("Page not Found")},
|
|
),
|
|
path("500/", default_views.server_error),
|
|
]
|
|
if "debug_toolbar" in settings.INSTALLED_APPS:
|
|
import debug_toolbar
|
|
|
|
urlpatterns = [path("__debug__/", include(debug_toolbar.urls))] + urlpatterns
|