codex 1.5.0a2__py3-none-any.whl → 1.5.0a3__py3-none-any.whl

codex/views/browser/filters/search.py

@@ -1,4 +1,5 @@
 """Search Filters Methods."""
+
 from django.db.models import Q
 
 from codex._vendor.haystack.query import SearchQuerySet

codex/views/browser/metadata.py

@@ -1,4 +1,5 @@
 """View for marking comics read and unread."""
+
 from typing import ClassVar
 
 from django.db.models import Count, F, IntegerField, Subquery, Value

codex/views/browser/session.py

@@ -1,4 +1,5 @@
 """Browser session view."""
+
 from codex.serializers.browser.settings import BrowserSettingsSerializer
 from codex.views.session import BrowserSessionViewBase, SessionViewBase
 

codex/views/const.py

@@ -1,2 +1,3 @@
 """Common view constants."""
+
 FALSY = {None, "", "false", "0", False}

codex/views/cover.py

@@ -1,4 +1,5 @@
 """Comic cover thumbnail view."""
+
 from typing import ClassVar
 
 from django.http import HttpResponse

codex/views/download.py

@@ -1,4 +1,5 @@
 """Download a comic archive."""
+
 from pathlib import Path
 from typing import ClassVar
 
@@ -26,6 +27,7 @@ class DownloadView(APIView, GroupACLMixin):
         "issue_suffix",
         "name",
     )
+    AS_ATTACHMENT = True
 
     @extend_schema(responses={(200, content_type): OpenApiTypes.BINARY})
     def get(self, *_args, **kwargs):
@@ -45,9 +47,23 @@ class DownloadView(APIView, GroupACLMixin):
 
         # FileResponse requires file handle not be closed in this method.
         comic_file = Path(comic.path).open("rb")  # noqa: SIM115
+        content_type = "application/"
+        if comic.file_type == "PDF":
+            content_type += "pdf"
+        elif comic.file_type:
+            content_type += "vnd.comicbook+" + comic.file_type.lower()
+        else:
+            content_type += "octet-stream"
+
         return FileResponse(
             comic_file,
-            as_attachment=True,
-            content_type=self.content_type,
+            as_attachment=self.AS_ATTACHMENT,
+            content_type=content_type,
             filename=comic.filename(),
         )
+
+
+class FileView(DownloadView):
+    """View a comic in the browser."""
+
+    AS_ATTACHMENT = False

codex/views/error.py

@@ -1,4 +1,5 @@
 """Custom Http Error Views."""
+
 from django.shortcuts import redirect
 from django.urls import reverse
 from rest_framework import status

codex/views/frontend.py

@@ -1,4 +1,5 @@
 """Frontend views."""
+
 from typing import ClassVar
 
 from rest_framework.renderers import TemplateHTMLRenderer

codex/views/opds/authentication_v1.py

@@ -1,4 +1,5 @@
 """OPDS Authentication 1.0."""
+
 from types import MappingProxyType
 
 from django.contrib.staticfiles.storage import staticfiles_storage

codex/views/opds/binary.py

@@ -1,4 +1,5 @@
 """Binary views with Basic Authentication added."""
+
 from rest_framework.authentication import BasicAuthentication, SessionAuthentication
 
 from codex.views.cover import CoverView

codex/views/opds/util.py

@@ -1,4 +1,5 @@
 """OPDS Utility classes."""
+
 from django.db.models import F
 from django.http.response import HttpResponseRedirect
 from django.urls import reverse

codex/views/opds/v1/data.py

@@ -1,4 +1,5 @@
 """OPDS v1 Data classes."""
+
 from dataclasses import dataclass
 from datetime import datetime
 

codex/views/opds/v1/entry/data.py

@@ -1,4 +1,5 @@
 """OPDS v1 Entry Data classes."""
+
 from collections.abc import Mapping
 from dataclasses import dataclass
 

codex/views/opds/v1/entry/entry.py

@@ -1,4 +1,5 @@
 """OPDS v1 Entry."""
+
 import json
 from datetime import datetime, timezone
 from urllib.parse import urlencode

codex/views/opds/v1/entry/links.py

@@ -1,4 +1,5 @@
 """OPDS v1 Entry Links Methods."""
+
 from urllib.parse import quote_plus
 
 from django.contrib.staticfiles.storage import staticfiles_storage

codex/views/opds/v1/facets.py

@@ -1,4 +1,5 @@
 """OPDS v1 Facets methods."""
+
 from dataclasses import dataclass
 from types import MappingProxyType
 

codex/views/opds/v1/feed.py

@@ -1,4 +1,5 @@
 """OPDS v1 feed."""
+
 from datetime import datetime, timezone
 from types import MappingProxyType
 from typing import TYPE_CHECKING, Any

codex/views/opds/v1/links.py

@@ -1,4 +1,5 @@
 """OPDS v1 Links methods."""
+
 from collections import defaultdict
 from collections.abc import Mapping
 from dataclasses import dataclass

codex/views/opds/v1/opensearch_v1.py

@@ -1,4 +1,5 @@
 """Serve an opensearch v1 document."""
+
 from drf_spectacular.types import OpenApiTypes
 from drf_spectacular.utils import extend_schema
 from rest_framework.authentication import BasicAuthentication, SessionAuthentication

codex/views/opds/v2/const.py

@@ -1,4 +1,5 @@
 """OPDS v2 consts."""
+
 from dataclasses import dataclass
 
 from codex.views.opds.const import Rel

codex/views/opds/v2/feed.py

@@ -1,4 +1,5 @@
 """OPDS v2.0 Feed."""
+
 from datetime import datetime, timezone
 from types import MappingProxyType
 

codex/views/opds/v2/links.py

@@ -1,4 +1,5 @@
 """Links methods for OPDS v2.0 Feed."""
+
 from copy import deepcopy
 from dataclasses import dataclass
 from urllib.parse import parse_qsl, urlparse

codex/views/opds/v2/publications.py

@@ -1,4 +1,5 @@
 """Publication Methods for OPDS v2.0 feed."""
+
 from types import MappingProxyType
 from urllib.parse import quote_plus
 

codex/views/opds/v2/top_links.py

@@ -1,4 +1,5 @@
 """OPDS v2.0 top links section methods."""
+
 from codex.views.opds.const import MimeType, Rel
 from codex.views.opds.v2.links import HrefData, LinkData, LinksMixin
 

codex/views/pwa.py

@@ -1,4 +1,5 @@
 """PWA views."""
+
 from codex.views.template import CodexTemplateView
 
 

codex/views/reader/reader.py

@@ -1,4 +1,5 @@
 """Views for reading comic books."""
+
 from django.db.models import F, IntegerField, Value
 from django.urls import reverse
 from drf_spectacular.types import OpenApiTypes
@@ -30,6 +31,7 @@ class ReaderView(BookmarkBaseView):
         "series",
         "volume",
         "reading_direction",
+        "updated_at",
     )
     _VALID_ARC_GROUPS = frozenset({"f", "s", "a"})
 
@@ -84,6 +86,7 @@ class ReaderView(BookmarkBaseView):
                 arc_name=F(arc_name_rel),
                 arc_index=arc_index,
             )
+            .annotate(mtime=F("updated_at"))
         )
 
         return qs.order_by(*ordering)

codex/views/reader/session.py

@@ -1,4 +1,5 @@
 """Reader session view."""
+
 from codex.serializers.reader import ReaderSettingsSerializer
 from codex.views.session import ReaderSessionViewBase, SessionViewBase
 

codex/views/session.py

@@ -1,4 +1,5 @@
 """Manage user sessions with appropriate defaults."""
+
 from abc import ABC, abstractmethod
 from copy import deepcopy
 from types import MappingProxyType

codex/views/template.py

@@ -1,4 +1,5 @@
 """Generic Codex Template View."""
+
 from rest_framework import status
 from rest_framework.renderers import TemplateHTMLRenderer
 from rest_framework.response import Response

codex/views/version.py

@@ -1,4 +1,5 @@
 """Version View."""
+
 from rest_framework.generics import GenericAPIView
 from rest_framework.response import Response
 

codex/websockets/aio_queue.py

@@ -1,4 +1,5 @@
 """Global queue to send async queue messages to consumers from other processes."""
+
 from aioprocessing import AioQueue
 
 BROADCAST_QUEUE = AioQueue()

codex/websockets/consumers.py

@@ -1,4 +1,5 @@
 """Notifier ChannelGroups Consumer."""
+
 from enum import Enum
 
 from channels.generic.websocket import AsyncWebsocketConsumer

codex/websockets/listener.py

@@ -1,4 +1,5 @@
 """Listens to the Broadcast Queue and sends its messages to channels."""
+
 from queue import Empty
 from types import MappingProxyType
 

codex/worker_base.py

@@ -1,4 +1,5 @@
 """General worker class inherits queues."""
+
 from codex.logger_base import LoggerBaseMixin
 from codex.status_controller import StatusController
 

{codex-1.5.0a2.dist-info → codex-1.5.0a3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codex
-Version: 1.5.0a2
+Version: 1.5.0a3
 Summary: A comic archive web server.
 Home-page: https://github.com/ajslater/codex
 License: GPL-3.0-only
@@ -28,7 +28,7 @@ Requires-Dist: aioprocessing (>=2.0.1,<3.0.0)
 Requires-Dist: ansicolors (>=1.1,<2.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.0.0rc9,<2.0.0)
+Requires-Dist: comicbox[pdf] (>=1.1.0,<2.0.0)
 Requires-Dist: django (>=5.0.1,<6.0.0)
 Requires-Dist: django-cors-headers (>=4.0,<5.0)
 Requires-Dist: django-rest-registration (>=0.8.0,<0.9.0)
@@ -44,7 +44,7 @@ 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: tzlocal (>=5.0,<6.0)
-Requires-Dist: watchdog (>=3.0,<4.0)
+Requires-Dist: watchdog (>=4.0,<5.0)
 Requires-Dist: websocket_client (>=1.2,<2.0)
 Requires-Dist: whitenoise[brotli] (>=6.0,<7.0)
 Requires-Dist: whoosh (>=2.7.4,<3.0.0)
@@ -119,6 +119,8 @@ You'll need to install these system dependencies before installing Codex.
 
 ##### macOS
 
+<!-- eslint-skip -->
+
 ```sh
 brew install jpeg libffi libyaml libzip openssl python unrar webp
 ```
@@ -129,12 +131,16 @@ brew install jpeg libffi libyaml libzip openssl python unrar webp
 
 ...and Ubuntu, Mint, MX and others.
 
+<!-- eslint-skip -->
+
 ```sh
 apt install build-essential libimagequant0 libjpeg62-turbo libopenjp2-7 libssl3 libyaml-0-2 libtiff6 libwebp7 python3-dev python3-pip mupdf unrar zlib1g
 ```
 
 ###### Alpine
 
+<!-- eslint-skip -->
+
 ```sh
 apk add bsd-compat-headers build-base jpeg-dev libffi-dev libwebp openssl-dev yaml-dev zlib-dev
 ```
@@ -163,6 +169,8 @@ Contributions to the Windows documentation will be gratefully accepted on
 
 You may now install Codex with pip
 
+<!-- eslint-skip -->
+
 ```sh
 pip3 install codex
 ```
@@ -171,12 +179,25 @@ pip3 install codex
 
 pip should install the codex binary on your path. Run
 
+<!-- eslint-skip -->
+
 ```sh
 codex
 ```
 
 and then navigate to <http://localhost:9810/>
 
+### Install & Run on your preexisting HomeAssistant server
+
+If you have a [HomeAssistant](https://www.home-assistant.io/) server, Codex can
+be installed with the following steps :
+
+- Add the `https://github.com/alexbelgium/hassio-addons` repository by
+  [clicking here](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
+- Install the addon :
+  [click here to automatically open the addon store, then install the addon](https://my.home-assistant.io/redirect/supervisor)
+- Customize addon options, then then start the add-on.
+
 ## <a name="administration">👑 Administration</a>
 
 ### Navigate to the Admin Panel
@@ -214,12 +235,16 @@ If you forget all your superuser passwords, you may restore the original default
 admin account by running codex with the `CODEX_RESET_ADMIN` environment variable
 set.
 
+<!-- eslint-skip -->
+
 ```sh
 CODEX_RESET_ADMIN=1 codex
 ```
 
 or, if using Docker:
 
+<!-- eslint-skip -->
+
 ```sh
 docker run -e CODEX_RESET_ADMIN=1 -v host-parent-dir/config:/config ajslater/codex
 ```
@@ -265,6 +290,8 @@ a default one to that directory on startup.
 
 The default values for the config options are:
 
+<!-- eslint-skip -->
+
 ```toml
 bind = ["0.0.0.0:9810"]
 quick_bind = ["0.0.0.0:9810"]
@@ -306,6 +333,8 @@ index, a Django cache and comic book cover thumbnails.
 
 Here's an example nginx config with a subpath named '/codex'.
 
+<!-- eslint-skip -->
+
 ```nginx
 # HTTP
 proxy_set_header   Host $http_host;
@@ -330,9 +359,10 @@ proxy_set_header Connection "Upgrade" location /codex {
 
 Specify a reverse proxy sub path (if you have one) in `config/hypercorn.toml`
 
+<!-- eslint-skip -->
+
 ```toml
 root_path = "/codex"
-
 ```
 
 #### Nginx Reverse Proxy 502 when container refreshes
@@ -420,6 +450,8 @@ You can change how much codex logs by setting the `LOGLEVEL` environment
 variable. By default this level is `INFO`. To see more verbose messages, run
 codex like:
 
+<!-- eslint-skip -->
+
 ```bash
 LOGLEVEL=DEBUG codex
 ```
@@ -440,6 +472,8 @@ If the database becomes corrupt, Codex includes a facitlity to rebuild the
 database. Place a file named `rebuild_db` in your Codex config directory like
 so:
 
+<!-- eslint-skip -->
+
 ```sh
 touch config/rebuild_db
 ```