codex 1.5.0rc1__py3-none-any.whl → 1.5.0rc2__py3-none-any.whl

codex/views/cover.py

@@ -20,7 +20,7 @@ class WEBPRenderer(BaseRenderer):
     """Render WEBP images."""
 
     media_type = "image/webp"
-    format = "webp"  # noqa A003
+    format = "webp"
     charset = None
     render_style = "binary"
 

codex/views/opds/const.py

@@ -4,7 +4,6 @@ from collections.abc import Mapping
 from types import MappingProxyType
 
 BLANK_TITLE = "Unknown"
-FALSY = {"", "false", "0"}
 AUTHOR_ROLES = {"Writer"}
 
 

codex/views/opds/v1/feed.py

@@ -12,11 +12,8 @@ from codex.serializers.opds.v1 import (
     OPDS1TemplateSerializer,
 )
 from codex.views.browser.browser import BrowserView
-from codex.views.opds.const import (
-    BLANK_TITLE,
-    FALSY,
-    MimeType,
-)
+from codex.views.const import FALSY
+from codex.views.opds.const import BLANK_TITLE, MimeType
 from codex.views.opds.v1.entry.data import OPDS1EntryData
 from codex.views.opds.v1.entry.entry import OPDS1Entry
 from codex.views.opds.v1.links import (

codex/views/opds/v2/feed.py

@@ -10,7 +10,8 @@ from codex.logger.logging import get_logger
 from codex.models import AdminFlag
 from codex.serializers.opds.v2 import OPDS2FeedSerializer
 from codex.views.browser.browser import BrowserView
-from codex.views.opds.const import BLANK_TITLE, FALSY
+from codex.views.const import FALSY
+from codex.views.opds.const import BLANK_TITLE
 from codex.views.opds.v2.const import (
     FACETS,
     FACETS_SECTION_DATA,

codex/views/opds/v2/links.py

@@ -6,7 +6,8 @@ from urllib.parse import parse_qsl, urlparse
 from django.urls import reverse
 
 from codex.views.browser.browser import BrowserView
-from codex.views.opds.const import FALSY, MimeType, Rel
+from codex.views.const import FALSY
+from codex.views.opds.const import MimeType, Rel
 from codex.views.opds.util import update_href_query_params
 
 
@@ -97,7 +98,7 @@ class LinksMixin(BrowserView):
     def _normalize_query_params(qps_dict):
         if qps_dict.get("orderBy") == "sort_name":
             qps_dict.pop("orderBy")
-        if qps_dict.get("orderReverse") == FALSY:
+        if qps_dict.get("orderReverse", "").lower() in FALSY:
             qps_dict.pop("orderReverse")
         return frozenset(qps_dict.items())
 

codex/views/reader/page.py

@@ -10,10 +10,10 @@ from rest_framework.negotiation import BaseContentNegotiation
 from codex.logger.logging import get_logger
 from codex.models import Comic
 from codex.views.bookmark import BookmarkBaseView
+from codex.views.const import FALSY
 
 LOG = get_logger(__name__)
 PDF_MIME_TYPE = "application/pdf"
-FALSY = {"", "false", "0", False}
 
 
 class IgnoreClientContentNegotiation(BaseContentNegotiation):
@@ -61,7 +61,7 @@ class ReaderPageView(BookmarkBaseView):
         pk = self.kwargs.get("pk")
         comic = Comic.objects.filter(group_acl_filter).only("path").get(pk=pk)
         page = self.kwargs.get("page")
-        to_pixmap = self.request.GET.get("pixmap") not in FALSY
+        to_pixmap = self.request.GET.get("pixmap", "").lower() not in FALSY
         if comic.file_type == Comic.FileType.PDF.value and not to_pixmap:
             content_type = PDF_MIME_TYPE
         else:

codex/views/template.py

@@ -9,7 +9,7 @@ class TemplateXMLRenderer(TemplateHTMLRenderer):
     """Template rendeerer for xml."""
 
     media_type = "text/xml"
-    format = "xml"  # noqa: A003
+    format = "xml"
 
 
 class SimpleAPIView(APIView):

{codex-1.5.0rc1.dist-info → codex-1.5.0rc2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codex
-Version: 1.5.0rc1
+Version: 1.5.0rc2
 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.0rc6,<2.0.0)
+Requires-Dist: comicbox[pdf] (>=1.0.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)
@@ -72,7 +72,7 @@ border-radius: 128px;
 - Filter and sort on all comic metadata and unread status per user.
 - Browse a tree of publishers, imprints, series, volumes, or your own folder
   hierarchy.
-- Read comics in a variety of aspect ratios that fit your screen.
+- Read comics in a variety of aspect ratios and directions that fit your screen.
 - Per user bookmarking. Per browser bookmarks even before you make an account.
 - Watches the filesystem and automatically imports new or changed comics.
 - Private Libraries accessible only to certain groups of users.
@@ -127,21 +127,10 @@ brew install jpeg libffi libyaml libzip openssl python unrar webp
 
 ###### <a href="#debian">Debian</a>
 
-Like Ubuntu, Mint, MX and others.
+...and Ubuntu, Mint, MX and others.
 
 ```sh
-apt install build-essential libffi-dev libjpeg-dev libssl-dev libwebp7 python3-pip zlib1g-dev
-```
-
-older releases may use the `libweb6` package instead.
-
-###### Debian on ARM
-
-The python cryptography wheel needs compiling on rare architectures. Install the
-Rust compiler.
-
-```sh
-apt install cargo
+apt install build-essential libimagequant0 libjpeg62-turbo libopenjp2-7 libssl3 libyaml-0-2 libtiff6 libwebp7 python3-dev python3-pip mupdf unrar zlib1g
 ```
 
 ###### Alpine
@@ -150,25 +139,25 @@ apt install cargo
 apk add bsd-compat-headers build-base jpeg-dev libffi-dev libwebp openssl-dev yaml-dev zlib-dev
 ```
 
-##### Install unrar Runtime Dependency on Linux
+##### Install unrar Runtime Dependency on non-debian Linux
 
-Codex requires unrar to read cbr formatted comic archives. Unrar is often not
+Codex requires unrar to read CBR formatted comic archives. Unrar is often not
 packaged for Linux, but here are some instructions:
 [How to install unrar in Linux](https://www.unixtutorial.org/how-to-install-unrar-in-linux/)
 
-Unrar as packaged for Alpine Linux v3.14 seems to work on Alpine v3.15
+Unrar as packaged for Alpine Linux v3.14 seems to work on Alpine v3.15+
 
 #### Windows
 
 Windows users should use Docker to run Codex until this documentation section is
 complete.
 
-Codex can _probably_ Windows Linux Subsystem but I haven't done personally
+Codex can _probably_ run on the Windows Linux Subsystem but I haven't personally
 tested it yet. Try following the instructions for [Debian](#debian) above. There
 may be outstanding platform related bugs.
 
-Contributions to this documentation accepted on
-[the outstanding issue](https://github.com/ajslater/codex/issues/76) or discord.
+Contributions to the Windows documentation will be gratefully accepted on
+[the outstanding issue](https://github.com/ajslater/codex/issues/76) or Discord.
 
 #### Install Codex with pip
 
@@ -248,6 +237,11 @@ A library with _any_ groups is accessible only to users who are in those groups.
 Use the Groups admin panel to create groups and the Users admin panel to add and
 remove users to groups.
 
+#### Include and Exclude Groups
+
+Codex can make groups for libraries that exclude groups of users or exclude
+everyone and include only certain groups of users.
+
 ### PDFs
 
 Codex only reads PDF metadata from the filename. If you decide to include PDFs
@@ -282,9 +276,11 @@ index, a Django cache and comic book cover thumbnails.
 
 ### Environment Variables
 
+### Codex
+
 - `LOGLEVEL` will change how verbose codex's logging is. Valid values are
   `ERROR`, `WARNING`, `INFO`, `DEBUG`. The default is `INFO`.
-- `TIMEZONE` or `TZ` will explicitly the timezone in long format (e.g.
+- `TIMEZONE` or `TZ` will explicitly set the timezone in long format (e.g.
   `"America/Los Angeles"`). This is useful inside Docker because codex cannot
   automatically detect the host machine's timezone.
 - `CODEX_CONFIG_DIR` will set the path to codex config directory. Defaults to
@@ -298,6 +294,12 @@ index, a Django cache and comic book cover thumbnails.
 - `CODEX_LOG_TO_FILE=0` will not log to files.
 - `CODEX_LOG_TO_CONSOLE=0` will not log to the console.
 
+#### Comicbox
+
+- `DEBUG_TRANSFORM` will show verbose information about how the comicbox library
+  reads all archive metadata sources and transforms it into a the comicbox
+  schema.
+
 ### Reverse Proxy
 
 [nginx](https://nginx.org/) is often used as a TLS terminator and subpath proxy.
@@ -346,11 +348,11 @@ Codex can run with as little as 1GB available RAM. Large batch jobs –like
 importing and indexing tens of thousands of comics at once– will run faster the
 more memory is available to Codex. The biggest gains in speed happen when you
 increase memory up to about 6GB. Codex batch jobs do get faster the more memory
-you give it above 6GB, but there are diminishing returns.
+it has above 6GB, but with diminishing returns.
 
-If you run Codex in an admin restricted memory environment you might want to
-temporarily give codex a lot of memory to run a very large batch job and then
-restrict it for normal operation.
+If you must run Codex in an admin restricted memory environment you might want
+to temporarily give Codex a lot of memory to run a very large import job and
+then restrict it for normal operation.
 
 ## <a name="usage">📖 Usage</a>