lanraragi-api 0.0.1__py3-none-any.whl

lanraragi_api/__init__.py

@@ -0,0 +1 @@
+from .lanraragi import LANrargiAPI

lanraragi_api/api/__init__.py

@@ -0,0 +1,7 @@
+from .archive import ArchiveAPI
+from .category import CategoryAPI
+from .database import DatabaseAPI
+from .minion import MinionAPI
+from .other import OtherAPI
+from .search import SearchAPI
+from .shinobu import ShinobuAPI

lanraragi_api/api/archive.py

@@ -0,0 +1,48 @@
+from script_house.utils import JsonUtils
+import requests
+
+from ..common.base import BaseAPICall
+from ..common.entity import Archive, Category
+
+
+class ArchiveAPI(BaseAPICall):
+    def get_archive_metadata(self, id: str) -> Archive:
+        """
+        Get Metadata (title, tags) for a given Archive.
+        :param id: ID of the Archive to process.
+        :return:
+        """
+        resp = requests.get(f"{self.server}/api/archives/{id}/metadata", params={'key': self.key},
+                            headers=self.build_headers())
+        return JsonUtils.to_obj(resp.text, Archive)
+
+    def get_all_archives(self) -> list[Archive]:
+        resp = requests.get(f"{self.server}/api/archives", params={'key': self.key}, headers=self.build_headers())
+        list = JsonUtils.to_obj(resp.text)
+        return [JsonUtils.to_obj(JsonUtils.to_str(o), Archive) for o in list]
+
+    def get_archive_categories(self, id: str) -> list[Category]:
+        """
+        Get all the Categories which currently refer to this Archive ID.
+        :param id: ID of the Archive to process.
+        :return:
+        """
+        resp = requests.get(f"{self.server}/api/archives/{id}/categories", params={'key': self.key},
+                            headers=self.build_headers())
+        clist = JsonUtils.to_obj(resp.text)["categories"]
+        return [JsonUtils.to_obj(JsonUtils.to_str(c), Category) for c in clist]
+
+    def update_archive_metadata(self, id: str, archive: Archive) -> bool:
+        """
+        Update tags and title for the given Archive. Data supplied to the server through
+        this method will <b>overwrite</b> the previous data.
+        :param archive: the Archive whose tags and title will be updated
+        :param id: ID of the Archive to process.
+        :return: whether update succeeds
+        """
+        resp = requests.put(f"{self.server}/api/archives/{id}/metadata", params={
+            'key': self.key,
+            'title': archive.title,
+            'tags': archive.tags
+        }, headers=self.build_headers())
+        return resp.status_code == 200

lanraragi_api/api/category.py

@@ -0,0 +1,5 @@
+from ..common.base import BaseAPICall
+
+
+class CategoryAPI(BaseAPICall):
+    pass

lanraragi_api/api/database.py

@@ -0,0 +1,5 @@
+from ..common.base import BaseAPICall
+
+
+class DatabaseAPI(BaseAPICall):
+    pass

lanraragi_api/api/minion.py

@@ -0,0 +1,5 @@
+from ..common.base import BaseAPICall
+
+
+class MinionAPI(BaseAPICall):
+    pass

lanraragi_api/api/other.py

@@ -0,0 +1,5 @@
+from ..common.base import BaseAPICall
+
+
+class OtherAPI(BaseAPICall):
+    pass

lanraragi_api/api/search.py

@@ -0,0 +1,5 @@
+from ..common.base import BaseAPICall
+
+
+class SearchAPI(BaseAPICall):
+    pass

lanraragi_api/api/shinobu.py

@@ -0,0 +1,5 @@
+from ..common.base import BaseAPICall
+
+
+class ShinobuAPI(BaseAPICall):
+    pass

lanraragi_api/common/base.py

@@ -0,0 +1,25 @@
+from enum import Enum
+
+
+class AUTH(str, Enum):
+    QUERY_PARAM = 'query param'
+    AUTH_HEADER = 'auth header'
+
+
+class BaseAPICall:
+
+    def __init__(self, key: str, server: str, auth_way: AUTH = AUTH.QUERY_PARAM, default_headers: dict[str, str] = {}):
+        assert auth_way == AUTH.QUERY_PARAM, 'AUTH.AUTH_HEADER is not supported now'
+        self.auth_way = auth_way
+        self.key = key
+        self.server = server
+        if self.server.endswith('/'):
+            self.server = self.server[:-1]
+        self.default_headers = default_headers
+
+    def build_headers(self, headers: dict[str, str] = {}):
+        for k in self.default_headers:
+            if k in headers:
+                continue
+            headers[k] = self.default_headers[k]
+        return headers

lanraragi_api/common/entity.py

@@ -0,0 +1,72 @@
+
+from pydantic import BaseModel
+
+
+class Archive(BaseModel):
+    arcid: str
+    isnew: str
+    extension: str
+    pagecount: int
+    progress: int
+    # k1:v1, k2:v2, v3, v4
+    tags: str
+    lastreadtime: int
+    title: str
+
+    def tags_to_dict(self) -> dict[str, list[str]]:
+        tags = self.tags.split(',')
+        ans = {}
+        for t in tags:
+            if t == '':
+                continue
+            t = t.strip()
+            if ':' in t:
+                kv = t.split(':')
+                k = kv[0]
+                v = kv[1]
+                if k not in ans:
+                    ans[k] = []
+                ans[k].append(v)
+            else:
+                k = "ONLY_VALUES"
+                if k not in ans:
+                    ans[k] = []
+                ans[k].append(t)
+        return ans
+
+    def dict_to_tags(self, json: dict[str, list[str]]):
+        """
+        The function will modify the object
+        """
+        tags = ""
+        modified: bool = False
+        for k in json:
+            for v in json[k]:
+                modified = True
+                if k == 'ONLY_VALUES':
+                    tags += f"{v},"
+                else:
+                    tags += f"{k}:{v},"
+        if modified:
+            tags = tags[:-1]
+        self.tags = tags
+
+    def set_artists(self, artists: list[str]):
+        json = self.tags_to_dict()
+        json['artist'] = artists
+        self.dict_to_tags(json)
+
+    def has_artists(self) -> bool:
+        return "artist" in self.tags
+
+
+class Category(BaseModel):
+    archives: list[str]
+    id: str
+    last_used: str
+    name: str
+    pinned: str
+    search: str
+
+
+

lanraragi_api/lanraragi.py

@@ -0,0 +1,13 @@
+from .api import *
+from .common.base import AUTH
+
+
+class LANrargiAPI:
+    def __init__(self, key: str, server: str, auth_way: AUTH = AUTH.QUERY_PARAM, default_headers: dict[str, str] = {}):
+        self.archive = ArchiveAPI(key, server, auth_way=auth_way, default_headers=default_headers)
+        self.category = CategoryAPI(key, server, auth_way=auth_way, default_headers=default_headers)
+        self.database = DatabaseAPI(key, server, auth_way=auth_way, default_headers=default_headers)
+        self.minion = MinionAPI(key, server, auth_way=auth_way, default_headers=default_headers)
+        self.other = OtherAPI(key, server, auth_way=auth_way, default_headers=default_headers)
+        self.search = SearchAPI(key, server, auth_way=auth_way, default_headers=default_headers)
+        self.shinobu = ShinobuAPI(key, server, auth_way=auth_way, default_headers=default_headers)

lanraragi_api-0.0.1.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.1
+Name: lanraragi-api
+Version: 0.0.1
+Summary: a Python library for LANraragi API
+Home-page: https://github.com/el-nino2020/lanraragi-api
+Author: El nino
+Author-email: el-nino202020@protonmail.com
+Description-Content-Type: text/markdown
+Requires-Dist: script-house
+
+# lanraragi-api
+
+a Python library for [LANraragi](https://github.com/Difegue/LANraragi) API.
+
+> Many thanks to the author of this wonderful manga server app.
+
+All the APIs are from [the official LANraragi document](https://sugoi.gitbook.io/lanraragi/api-documentation/getting-started). 
+
+Besides those basic APIs, I also made some enhancements for better use, e.g. [`lanraragi_api.common.entity.Archive#set_artists(self, artists: list[str])`](./lanraragi_api/common/entity.py)
+
+# Demo
+
+```python
+from lanraragi_api import LANrargiAPI
+from lanraragi_api.common.entity import Archive
+
+lgg_apikey = ''
+lgg_server = 'http://127.0.0.1:3000'
+api = LANrargiAPI(lgg_apikey, lgg_server)
+
+archives: list[Archive] = api.archive.get_all_archives()
+print(archives[0])
+```
+
+# Build
+```shell
+python.exe .\setup.py bdist_wheel sdist
+```

lanraragi_api-0.0.1.dist-info/RECORD

@@ -0,0 +1,17 @@
+lanraragi_api/__init__.py,sha256=Ja69i2AOG6rC5Lc_tlL1K56oKw9O2lbcD1PrV4w0djo,34
+lanraragi_api/lanraragi.py,sha256=e8hbNWPUeBpud3l6LcA5w1B-H1-41pvCddaKU6ANY9Q,892
+lanraragi_api/api/__init__.py,sha256=r-kIIk1u9ohq4H4W1RAreR7BVGUowB5chd8DksvlvcE,227
+lanraragi_api/api/archive.py,sha256=0akp-Tzf0qrMMXGXrwtJAYTpL45W9x9wCAshPds4KLQ,2118
+lanraragi_api/api/category.py,sha256=81uoxveS3-q8Qn0VSNqN7K3YBawusQj1mIoc4axX-rc,86
+lanraragi_api/api/database.py,sha256=vzXzRyYH-FCHswNRnkTZPtz7vvnxqju8cmpocp1Bk1o,86
+lanraragi_api/api/minion.py,sha256=aXxNi4iZnQ8qPmERb014f7lHSZMBS5DLg6guaVfoQ-0,84
+lanraragi_api/api/other.py,sha256=sIcRCIcfFDyOwq6hXsXw2O7piR4m2XlkdIMtMNQFxFg,83
+lanraragi_api/api/search.py,sha256=C3TQ52w_AYg05JNxvO-gdYw7aztTcJ84DtublYv-ryw,84
+lanraragi_api/api/shinobu.py,sha256=8VQ6Brcy7aLdF06dDN_6NCetYYheqzfvHiaTKRcOPzk,85
+lanraragi_api/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+lanraragi_api/common/base.py,sha256=eFlKb-dAK9Hlo0YVy-_hmjw1tdAur_jf9FZFMfaKrc4,801
+lanraragi_api/common/entity.py,sha256=S-jX91XDmdoqrv8LBg9VfE0WAix0hCQG8_LuwOM4h1A,1703
+lanraragi_api-0.0.1.dist-info/METADATA,sha256=4XwqxviSllU0AZ1OWES8ixJ8W42o7R3VxAoVUXXd-N4,1144
+lanraragi_api-0.0.1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+lanraragi_api-0.0.1.dist-info/top_level.txt,sha256=fedIf5V5Qp9ajuI0dkjWTCwK7Kb46Xiww4CP1kTXouM,14
+lanraragi_api-0.0.1.dist-info/RECORD,,

lanraragi_api-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.41.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

lanraragi_api-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+lanraragi_api