codex 1.6.0a6__py3-none-any.whl → 1.6.0a8__py3-none-any.whl

codex/views/settings.py

@@ -0,0 +1,34 @@
+"""Settings View."""
+
+from abc import ABC
+
+from drf_spectacular.utils import extend_schema
+from rest_framework.response import Response
+
+from codex.views.session import SessionView
+
+
+class SettingsView(SessionView, ABC):
+    """Settings View."""
+
+    def get(self, *args, **kwargs):
+        """Get session settings."""
+        defaults = self.SESSION_DEFAULTS[self.SESSION_KEY]
+        session = self.request.session.get(self.SESSION_KEY, defaults)
+        params = self._get_source_values_or_set_defaults(defaults, session, {})
+        data = {}
+        for key, filter_name in params.get("filters", {}).items():
+            if filter_name:
+                data[key] = filter_name
+        params["filters"] = data
+        serializer = self.get_serializer(params)
+        return Response(serializer.data)
+
+    @extend_schema(responses=None)
+    def put(self, *args, **kwargs):
+        """Update session settings."""
+        data = self.request.data  # type: ignore
+        serializer = self.get_serializer(data=data)
+        serializer.is_valid(raise_exception=True)
+        self.save_params_to_session(serializer.validated_data)
+        return Response()

codex/views/template.py

@@ -13,7 +13,7 @@ class TemplateXMLRenderer(TemplateHTMLRenderer):
     format = "xml"
 
 
-class SimpleAPIView(APIView):
+class CodexAPIView(APIView):
     """APIView with a simple getter and no data."""
 
     content_type = "application/json"
@@ -26,14 +26,14 @@ class SimpleAPIView(APIView):
         )
 
 
-class CodexTemplateView(SimpleAPIView):
+class CodexTemplateView(CodexAPIView):
     """HTML Template View."""
 
     renderer_classes = (TemplateHTMLRenderer,)
     content_type = "text/html"
 
 
-class CodexXMLTemplateView(SimpleAPIView):
+class CodexXMLTemplateView(CodexAPIView):
     """XML Template View."""
 
     renderer_classes = (TemplateXMLRenderer,)

codex/views/util.py

@@ -0,0 +1,63 @@
+"""Utility classes by many views."""
+
+import json
+from collections.abc import Mapping
+from contextlib import suppress
+from dataclasses import asdict, dataclass
+from json.decoder import JSONDecodeError
+from urllib.parse import unquote_plus
+
+from djangorestframework_camel_case.settings import api_settings
+from djangorestframework_camel_case.util import underscoreize
+
+
+@dataclass()
+class Route(dict):
+    """Breadcrumb, like a route."""
+
+    group: str
+    pks: tuple[int, ...]
+    page: int = 1
+    name: str = ""
+
+    def __eq__(self, cmp):
+        """Breadcrumb equality."""
+        return (
+            bool(cmp is not None)
+            and (self.group == cmp.group)
+            and (set(self.pks) == set(cmp.pks))
+        )
+
+    def __and__(self, cmp):
+        """Breadcrumb intersection."""
+        return (
+            bool(cmp is not None)
+            and (self.group == cmp.group)
+            and (set(self.pks) & set(cmp.pks))
+        )
+
+    dict = asdict
+
+
+def reparse_json_query_params(query_params, keys) -> dict:
+    """Reparse JSON encoded query_params."""
+    # It is an unbelievable amount of trouble to try to parse axios native bracket
+    # encoded complex objects in python
+    parsed_dict = {}
+    for key, value in query_params.items():
+        if key in keys:
+            parsed_value = unquote_plus(value)
+            with suppress(JSONDecodeError):
+                parsed_value = json.loads(parsed_value)
+        else:
+            parsed_value = value
+
+        parsed_dict[key] = parsed_value
+    return dict(underscoreize(parsed_dict, **api_settings.JSON_UNDERSCOREIZE))  # type:ignore
+
+
+def pop_name(kwargs: Mapping):
+    """Pop name from a mapping route."""
+    kwargs = dict(kwargs)
+    kwargs.pop("name", None)
+    return kwargs

codex/views/version.py

@@ -1,13 +1,13 @@
 """Version View."""
 
-from rest_framework.generics import GenericAPIView
 from rest_framework.response import Response
 
 from codex.serializers.versions import VersionsSerializer
 from codex.version import PACKAGE_NAME, VERSION, get_latest_version
+from codex.views.auth import AuthGenericAPIView
 
 
-class VersionView(GenericAPIView):
+class VersionView(AuthGenericAPIView):
     """Return Codex Versions."""
 
     serializer_class = VersionsSerializer

{codex-1.6.0a6.dist-info → codex-1.6.0a8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codex
-Version: 1.6.0a6
+Version: 1.6.0a8
 Summary: A comic archive web server.
 Home-page: https://github.com/ajslater/codex
 License: GPL-3.0-only
@@ -29,22 +29,23 @@ Requires-Dist: ansicolors (>=1.1,<2.0)
 Requires-Dist: bidict (>=0.23.1,<0.24.0)
 Requires-Dist: case-converter (>=1.1.0,<2.0.0)
 Requires-Dist: channels (>=4.0.0,<5.0.0)
-Requires-Dist: comicbox[pdf] (>=1.1.7,<2.0.0)
+Requires-Dist: comicbox[pdf] (>=1.1.8,<2.0.0)
 Requires-Dist: django (>=5.0.6,<6.0.0)
 Requires-Dist: django-cachalot (>=2.6.2,<3.0.0)
 Requires-Dist: django-cors-headers (>=4.0,<5.0)
-Requires-Dist: django-rest-registration (>=0.8.0,<0.9.0)
+Requires-Dist: django-rest-registration (>=0.8.3,<0.9.0)
 Requires-Dist: django-vite (>=3.0.1,<4.0.0)
-Requires-Dist: djangorestframework (>=3.11,<4.0)
-Requires-Dist: djangorestframework-camel-case (>=1.3.0,<2.0.0)
-Requires-Dist: drf-spectacular (>=0.27.0,<0.28.0)
+Requires-Dist: djangorestframework (>=3.15.1,<4.0.0)
+Requires-Dist: djangorestframework-camel-case (>=1.4.2,<2.0.0)
+Requires-Dist: drf-spectacular (>=0.27.2,<0.28.0)
 Requires-Dist: fnvhash (>=0.1,<0.2)
 Requires-Dist: humanfriendly (>=10.0,<11.0)
 Requires-Dist: humanize (>=4.0.0,<5.0.0)
-Requires-Dist: hypercorn[h3] (>=0.16.0,<0.17.0)
+Requires-Dist: hypercorn[h3] (>=0.17.3,<0.18.0)
 Requires-Dist: psutil (>=5.9.4,<6.0.0)
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: requests (>=2.24,<3.0)
+Requires-Dist: setuptools (>=70.0.0,<71.0.0)
 Requires-Dist: tzlocal (>=5.0,<6.0)
 Requires-Dist: watchdog (>=4.0,<5.0)
 Requires-Dist: websocket_client (>=1.2,<2.0)
@@ -347,12 +348,13 @@ index, a Django cache and comic book cover thumbnails.
 
 Codex contains some experimental throttling controls. The value supplied to
 these variables will be interpreted as the maximum number of allowed requests
-per minute.
+per minute. For example, the following settings would limit each described group
+to 2 queries per second.
 
-- `CODEX_THROTTLE_ANON=60` Anonymous users
-- `CODEX_THROTTLE_USER=60` Authenticated users
-- `CODEX_THROTTLE_OPDS=60` The OPDS v1 & v2 APIs
-- `CODEX_THROTTLE_OPENSEARCH=60` The OPDS v1 Opensearch API
+- `CODEX_THROTTLE_ANON=30` Anonymous users
+- `CODEX_THROTTLE_USER=30` Authenticated users
+- `CODEX_THROTTLE_OPDS=30` The OPDS v1 & v2 APIs (Panels uses this for search)
+- `CODEX_THROTTLE_OPENSEARCH=30` The OPDS v1 Opensearch API
 
 ### Reverse Proxy
 
@@ -438,14 +440,17 @@ OPDS 2.0 book readers exist, but I am not yet aware of an OPDS 2.0 comic reader.
 
 #### Clients
 
-- iOS has [Panels](https://panels.app/), [KYBook 3](http://kybook-reader.com/),
-  and
+- iOS has [Panels](https://panels.app/), [PocketBooks](https://pocketbook.ch/),
+  [KYBook 3](http://kybook-reader.com/), and
   [Chunky Comic Reader](https://apps.apple.com/us/app/chunky-comic-reader/id663567628)
 - Android has
   [Moon+](https://play.google.com/store/apps/details?id=com.flyersoft.moonreader)
   and
   [Librera](https://play.google.com/store/apps/details?id=com.foobnix.pdf.reader)
 
+Kybook 3 does not seem to support http basic authentication, so Cbbodex users
+are not supported.
+
 #### HTTP Basic Authentication
 
 If you wish to access OPDS as your Codex User. You will have to add your