codex 1.7.2__py3-none-any.whl → 1.7.3__py3-none-any.whl

codex/views/util.py

@@ -5,6 +5,7 @@ from collections.abc import Mapping
 from contextlib import suppress
 from dataclasses import asdict, dataclass
 from json.decoder import JSONDecodeError
+from typing import Any
 from urllib.parse import unquote_plus
 
 from djangorestframework_camel_case.settings import api_settings
@@ -43,7 +44,7 @@ class Route(dict):
     dict = asdict
 
 
-def reparse_json_query_params(query_params, keys) -> dict:
+def reparse_json_query_params(query_params, keys) -> dict[str, Any]:
     """Reparse JSON encoded query_params."""
     # It is an unbelievable amount of trouble to try to parse axios native bracket
     # encoded complex objects in python
@@ -57,7 +58,7 @@ def reparse_json_query_params(query_params, keys) -> dict:
             parsed_value = value
 
         parsed_dict[key] = parsed_value
-    return dict(underscoreize(parsed_dict, **api_settings.JSON_UNDERSCOREIZE))  # type:ignore
+    return dict(underscoreize(parsed_dict, **api_settings.JSON_UNDERSCOREIZE))  # type:ignore[reportReturnType]
 
 
 def pop_name(kwargs: Mapping):
@@ -67,11 +68,11 @@ def pop_name(kwargs: Mapping):
     return kwargs
 
 
-async def chunker(open_file, chunk_size=DEFAULT_CHUNK_SIZE):
+def chunker(open_file, chunk_size=DEFAULT_CHUNK_SIZE):
     """Asynchronous iterator for serving files."""
-    while True:
-        chunk = open_file.read(chunk_size)
-        if not chunk:
-            open_file.close()
-            break
-        yield chunk
+    with open_file:
+        while True:
+            if chunk := open_file.read(chunk_size):
+                yield chunk
+            else:
+                break

codex/views/version.py

@@ -15,7 +15,7 @@ class VersionView(AuthGenericAPIView):
 
     serializer_class = VersionsSerializer
 
-    def get_object(self) -> dict[str, str]:  # type: ignore
+    def get_object(self) -> dict[str, str]:
         """Get the versions."""
         ts = Timestamp.objects.get(key=Timestamp.TimestampChoices.CODEX_VERSION.value)
         if ts.version:

{codex-1.7.2.dist-info → codex-1.7.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codex
-Version: 1.7.2
+Version: 1.7.3
 Summary: A comic archive web server.
 Home-page: https://github.com/ajslater/codex
 License: GPL-3.0-only
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Multimedia :: Graphics :: Viewers
@@ -143,8 +144,6 @@ before installing Codex.
 
 ...and Ubuntu, Mint, MX, Window Subsystem for Linux, and others.
 
-<!-- eslint-skip -->
-
 ```sh
 apt install build-essential libimagequant0 libjpeg-turbo8 libopenjp2-7 libssl libyaml-0-2 libtiff6 libwebp7 python3-dev python3-pip mupdf sqlite3 unrar zlib1g
 ```
@@ -154,16 +153,12 @@ and versions of your distribution. If the package versions listed in the example
 above are not available, try searching for ones that are with `apt-cache` or
 `aptitude`.
 
-<!-- eslint-skip -->
-
 ```sh
 apt-cache search libjpeg-turbo
 ```
 
 ###### <a href="alpine">Alpine</a> Dependencies
 
-<!-- eslint-skip -->
-
 ```sh
 apk add bsd-compat-headers build-base jpeg-dev libffi-dev libwebp openssl-dev sqlite yaml-dev zlib-dev
 ```
@@ -180,8 +175,6 @@ Unrar as packaged for Alpine Linux v3.14 seems to work on Alpine v3.15+
 
 Using [Homebrew](https://brew.sh/):
 
-<!-- eslint-skip -->
-
 ```sh
 brew install jpeg libffi libyaml libzip openssl python sqlite unrar webp
 ```
@@ -199,8 +192,6 @@ Dependencies Installation Document</a>.
 Once you have installed codex, the codex binary should be on your path. To start
 codex, run:
 
-<!-- eslint-skip -->
-
 ```sh
 codex
 ```
@@ -246,16 +237,12 @@ 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
 ```
@@ -315,8 +302,6 @@ 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"]
@@ -374,8 +359,6 @@ to 2 queries per second.
 
 Here's an example nginx config with a subpath named '/codex'.
 
-<!-- eslint-skip -->
-
 ```nginx
 # HTTP
 proxy_set_header   Host $http_host;
@@ -400,8 +383,6 @@ 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"
 ```
@@ -473,11 +454,17 @@ authentication. In that case the OPDS url will look like:
 
 #### Supported OPDS Specifications
 
+##### OPDS v1
+
 - [OPDS 1.2](https://specs.opds.io/opds-1.2.html)
 - [OPDS-PSE 1.2](https://github.com/anansi-project/opds-pse/blob/master/v1.2.md)
 - [OPDS Authentication 1.0](https://drafts.opds.io/authentication-for-opds-1.0.html)
 - [OpenSearch 1.1](https://github.com/dewitt/opensearch)
+
+##### OPDS v2
+
 - [OPDS 2.0 (draft)](https://drafts.opds.io/opds-2.0.html)
+- [OPDS 2.0 Progression (proposal)](https://github.com/opds-community/drafts/discussions/67)
 
 ## <a name="troubleshooting">🩺 Troubleshooting</a>
 
@@ -490,9 +477,7 @@ 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
+```sh
 LOGLEVEL=DEBUG codex
 ```
 
@@ -512,8 +497,6 @@ If the database becomes corrupt, Codex includes a facility to rebuild the
 database. Place a file named `rebuild_db` in your Codex config directory like
 so:
 
-<!-- eslint-skip -->
-
 ```sh
 touch config/rebuild_db
 ```
@@ -526,6 +509,18 @@ rebuild it. The database lives in the config directory as the file
 original database at `config/backups/codex.sqlite3.before-rebuild`. Codex will
 remove the `rebuild_db` file.
 
+### Warnings to Ignore
+
+#### StreamingHttpResponse Iterator Warning
+
+```pycon
+packages/django/http/response.py:517: Warning: StreamingHttpResponse must consume synchronous iterators in order to serve them asynchronously. Use an asynchronous iterator instead.
+```
+
+This is a known warning and does not represent anything bad happening. It's an
+artifact of the Django framework slowly supporting asynchronous server endpoints
+and unfortunately isn't practical to remove yet.
+
 ## <a name="alternatives-to-codex">📚Alternatives</a>
 
 - [Kavita](https://www.kavitareader.com/) has light metadata filtering/editing,