Merge pull request #172 from DakaraProject/dependencies/update2

Update dependencies

Author: Neraste

.github/workflows/ci.yml

@@ -18,7 +18,6 @@ jobs:
           - macos-latest
           - windows-latest
         python-version:
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v5.0.0
     hooks:
     - id: trailing-whitespace
     - id: end-of-file-fixer

CHANGELOG.md

@@ -42,11 +42,14 @@ Any important notes regarding the update.
 
 ### Changed
 
+- Self documentation of the API is now handled by `drf-spectacular`.
 - Playlist is integrated to the digest view in its minimal form.
 - Played and queuing playlist entries can be accessed in a library fashion (using pagination), their routes are `playlist/played` and `playlist/queuing`.
 
 ### Removed
 
+- Removed documentation URL entry point `api-doc`.
+- Dropped Python 3.9 support.
 - Dropped Python 3.8 support.
 - Dropped Python 3.7 support.
 - Playlist entries in digest view don't have pre-calculated date of play any more. This data has to be calculated by the front now.

README.md

@@ -19,7 +19,7 @@ Installation guidelines are provided over here:
 
 ### System requirements
 
-* Python3, to make everything up and running (supported versions: 3.9, 3.10, 3.11, and 3.12).
+* Python3, to make everything up and running (supported versions: 3.10, 3.11, and 3.12).
 
 Linux, Mac and Windows are supported.
 

dakara_server/dakara_server/settings/base.py

@@ -31,6 +31,7 @@
     "django.contrib.staticfiles",
     "rest_framework",
     "rest_framework.authtoken",
+    "drf_spectacular",
     "channels",
     "ordered_model",
     "rest_registration",
@@ -118,7 +119,15 @@
     "DEFAULT_PAGINATION_CLASS": "internal.pagination.PageNumberPaginationCustom",
     "PAGE_SIZE": 10,
     "TEST_REQUEST_DEFAULT_FORMAT": "json",
-    "DEFAULT_SCHEMA_CLASS": "rest_framework.schemas.coreapi.AutoSchema",
+    "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
+}
+
+# DRF Spectacular settings
+SPECTACULAR_SETTINGS = {
+    "TITLE": "Dakara server API",
+    "DESCRIPTION": "Server for the Dakara project",
+    "VERSION": VERSION,
+    "SERVE_INCLUDE_SCHEMA": False,
 }
 
 

dakara_server/dakara_server/token_auth.py

@@ -3,6 +3,7 @@
 From: https://gist.github.com/rluts/22e05ed8f53f97bdd02eafdf38f3d60a
 From: https://gist.github.com/AliRn76/1fb99688315bedb2bf32fc4af0e50157
 """
+
 from urllib.parse import parse_qs
 
 from channels.db import database_sync_to_async

dakara_server/dakara_server/urls.py

@@ -13,12 +13,11 @@
     1. Add an import:  from blog import urls as blog_urls
     2. Add a URL to urlpatterns:  url(r'^blog/', include(blog_urls))
 """
+
 from django.conf import settings
-from django.conf.urls import re_path
 from django.contrib import admin
 from django.contrib.staticfiles.views import serve
-from django.urls import include, path
-from rest_framework.documentation import include_docs_urls
+from django.urls import include, path, re_path
 
 from internal import views as internal_views
 from library import views as library_views
@@ -158,17 +157,14 @@
         library_views.SongTagView.as_view(),
         name="library-songtag",
     ),
-    # API documentation routes
-    path("api-docs/", include_docs_urls(title="Dakara server API")),
 ]
 
 if settings.DEBUG:
     urlpatterns.extend(
         [
             # Default to main page
             re_path(
-                r"^(?!api/|api-docs/?)",  # serve everything but the API routes
-                # API documentation routes
+                r"^(?!api/?)",  # serve everything but the API routes
                 serve,
                 kwargs={"path": "index.html"},
             )

dakara_server/internal/apps.py

@@ -1,8 +1,8 @@
-import os
 from abc import ABC
 
 from django.apps import AppConfig
 
+from internal.reloader import is_reloader
 from internal.version import check_version
 
 
@@ -15,21 +15,11 @@ class DakaraConfig(AppConfig, ABC):
     """
 
     def ready(self):
-        """Method called when app start.
-
-        When the server is run with the `runserver` command, two instances of
-        the project are running and hence this method is called twice: one for
-        the reloader and one for the actual development server. The reloader
-        creates the environment variable `RUN_MAIN` with the value "true", so
-        it can be distinguighed.
-
-        See: https://stackoverflow.com/q/33814615
-        See: django/utils/autoreload.py
-        """
+        """Method called when app start."""
         # The code below can be executed by the reloader
         self.ready_reload()
 
-        if os.environ.get("RUN_MAIN") == "true":
+        if is_reloader():
             return
 
         # The code bellow cannot be executed by the reloader

dakara_server/internal/reloader.py

@@ -0,0 +1,19 @@
+import os
+
+
+def is_reloader():
+    """Detect if the current instance is a reloader.
+
+    When the server is run with the `runserver` command, two instances of the
+    project are running and hence this method is called twice: one for the
+    reloader and one for the actual development server. The reloader creates
+    the environment variable `RUN_MAIN` with the value "true", so it can be
+    distinguighed.
+
+    Returns:
+        bool: True if the current instance is a reloader.
+
+    See: https://stackoverflow.com/q/33814615
+    See: django/utils/autoreload.py
+    """
+    return os.environ.get("RUN_MAIN") == "true"

dakara_server/internal/serializers.py

@@ -0,0 +1,9 @@
+from rest_framework import serializers
+
+
+class SettingsSerializer(serializers.Serializer):
+    """Settings."""
+
+    version = serializers.CharField(read_only=True)
+    date = serializers.DateTimeField(read_only=True)
+    email_enabled = serializers.BooleanField(read_only=True)