Dev (#40)

- Migrate to using [rye](https://rye.astral.sh/)
- Rename `SearchResult` to `GenericComic`
- Minor tidyups

Author: Buried-In-Code

.github/dependabot.yaml

@@ -1,10 +1,19 @@
 version: 2
 updates:
-  - package-ecosystem: pip
+  - package-ecosystem: github-actions
     directory: /
     schedule:
       interval: daily
-  - package-ecosystem: github-actions
+    groups:
+      github_actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: pip
     directory: /
     schedule:
       interval: daily
+    groups:
+      python:
+        patterns:
+          - "*"

.github/workflows/testing.yaml

@@ -22,8 +22,8 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - 3.8
-          - 3.9
+          - '3.8'
+          - '3.9'
           - '3.10'
           - '3.11'
           - '3.12'

.pre-commit-config.yaml

@@ -1,7 +1,8 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.292
+    rev: v0.5.0
     hooks:
+      - id: ruff-format
       - id: ruff
   - repo: https://github.com/executablebooks/mdformat
     rev: 0.7.17
@@ -14,7 +15,7 @@ repos:
           - --number
           - --wrap=keep
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-ast
       - id: check-builtin-literals
@@ -38,10 +39,6 @@ repos:
       - id: trailing-whitespace
         args:
           - --markdown-linebreak-ext=md
-  - repo: https://github.com/psf/black
-    rev: 23.9.1
-    hooks:
-      - id: black
   - repo: https://github.com/pappasam/toml-sort
     rev: v0.23.1
     hooks:

.readthedocs.yaml

@@ -8,7 +8,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.12"
 
 mkdocs:
   configuration: mkdocs.yaml

LICENSE.txt LICENSELICENSE.txt renamed to LICENSE

@@ -5,10 +5,9 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/Himon.svg?logo=Python&label=Version&style=flat-square)](https://pypi.python.org/pypi/Himon/)
 [![PyPI - License](https://img.shields.io/pypi/l/Himon.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/GPL-3.0)
 
-[![Hatch](https://img.shields.io/badge/Packaging-Hatch-4051b5?style=flat-square)](https://github.com/pypa/hatch)
-[![Pre-Commit](https://img.shields.io/badge/Pre--Commit-Enabled-informational?style=flat-square&logo=pre-commit)](https://github.com/pre-commit/pre-commit)
-[![Black](https://img.shields.io/badge/Code--Style-Black-000000?style=flat-square)](https://github.com/psf/black)
-[![Ruff](https://img.shields.io/badge/Linter-Ruff-informational?style=flat-square)](https://github.com/charliermarsh/ruff)
+[![Rye](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/rye/main/artwork/badge.json)](https://rye.astral.sh)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 [![Github - Contributors](https://img.shields.io/github/contributors/Buried-In-Code/Himon.svg?logo=Github&label=Contributors&style=flat-square)](https://github.com/Buried-In-Code/Himon/graphs/contributors)
 [![Github Action - Testing](https://img.shields.io/github/actions/workflow/status/Buried-In-Code/Himon/testing.yaml?branch=main&logo=Github&label=Testing&style=flat-square)](https://github.com/Buried-In-Code/Himon/actions/workflows/testing.yaml)
@@ -37,33 +36,25 @@ session = LeagueofComicGeeks(client_id="Client Id", client_secret="Client Secret
 
 # Generate an access token if not supplied
 if not session.access_token:
-  session.access_token = session.generate_access_token()
+    session.access_token = session.generate_access_token()
 
 # Search for Comic
-for search in session.search(search_term="Blackest Night"):
-    print(f"Search result: {search.publisher_name} - {search.series_name} - {search.title}")
+for result in session.search(search_term="Blackest Night"):
+    print(f"Result: {result.publisher_name} - {result.series_name} - {result.title}")
 
 # Get Series by id
-series = session.series(series_id=100096)
-print(f"Series: {series.series_id} - {series.title}")
+series = session.get_series(series_id=100096)
+print(f"Series: {series.id} - {series.title}")
 
 # Get Comic by id
-comic = session.comic(comic_id=2710631)
-print(f"Comic: {comic.comic_id} - {comic.title}")
+comic = session.get_comic(comic_id=2710631)
+print(f"Comic: {comic.id} - {comic.title}")
 ```
 
 ## Bugs/Requests
 
 Please use the [GitHub issue tracker](https://github.com/Buried-In-Code/Himon/issues) to submit bugs or request features.
 
-## Notes
-
-Who or what is Himon?
-
-> Himon is a citizen of New Genesis who secretly lives on the planet Apokolips, which is ruled by Darkseid.
->
-> More details at [Himon (New Earth)](<https://dc.fandom.com/wiki/Himon_(New_Earth)>)
-
 ## Socials
 
 [![Social - Matrix](https://img.shields.io/matrix/The-Dev-Environment:matrix.org?label=The%20Dev%20Environment&logo=matrix&style=for-the-badge)](https://matrix.to/#/#The-Dev-Environment:matrix.org)

README.md

@@ -0,0 +1,4 @@
+# Generic
+
+::: himon.schemas.generic.GenericComic
+::: himon.schemas.generic.GenericCover

docs/himon/schemas/generic.md

@@ -1,5 +1,6 @@
 """himon package entry file."""
-__version__ = "0.5.0"
+
+__version__ = "0.6.0"
 __all__ = ["__version__", "get_cache_root"]
 
 import os

docs/himon/schemas/search_result.md

@@ -4,6 +4,7 @@
 
 - LeagueofComicGeeks
 """
+
 from __future__ import annotations
 
 __all__ = ["LeagueofComicGeeks"]
@@ -19,7 +20,7 @@
 from himon import __version__
 from himon.exceptions import AuthenticationError, ServiceError
 from himon.schemas.comic import Comic
-from himon.schemas.search_result import SearchResult
+from himon.schemas.generic import GenericComic
 from himon.schemas.series import Series
 from himon.sqlite_cache import SQLiteCache
 
@@ -68,9 +69,7 @@ def __init__(
     @sleep_and_retry
     @limits(calls=20, period=MINUTE)
     def _perform_get_request(
-        self: LeagueofComicGeeks,
-        url: str,
-        params: dict[str, str] | None = None,
+        self: LeagueofComicGeeks, url: str, params: dict[str, str] | None = None
     ) -> dict[str, Any]:
         """Make GET request to League of Comic Geeks.
 
@@ -153,9 +152,7 @@ def _get_request(
     @sleep_and_retry
     @limits(calls=20, period=MINUTE)
     def _str_get_request(
-        self: LeagueofComicGeeks,
-        endpoint: str,
-        params: dict[str, str] | None = None,
+        self: LeagueofComicGeeks, endpoint: str, params: dict[str, str] | None = None
     ) -> str:
         """Make GET request to League of Comic Geeks, expecting a str response.
 
@@ -211,7 +208,7 @@ def generate_access_token(self: LeagueofComicGeeks) -> str:
         self.headers["X-API-KEY"] = self.client_secret
         return self._str_get_request("/authorize/format/json")
 
-    def search(self: LeagueofComicGeeks, search_term: str) -> list[SearchResult]:
+    def search(self: LeagueofComicGeeks, search_term: str) -> list[GenericComic]:
         """Request a list of search results.
 
         Args:
@@ -225,7 +222,7 @@ def search(self: LeagueofComicGeeks, search_term: str) -> list[SearchResult]:
         try:
             self.headers["X-API-KEY"] = self.access_token
             results = self._get_request("/search/format/json", params={"query": search_term})
-            adapter = TypeAdapter(List[SearchResult])
+            adapter = TypeAdapter(List[GenericComic])
             return adapter.validate_python(results)
         except ValidationError as err:
             raise ServiceError(err) from err
@@ -244,10 +241,7 @@ def get_series(self: LeagueofComicGeeks, series_id: int) -> Series:
         """
         try:
             self.headers["X-API-KEY"] = self.access_token
-            result = self._get_request(
-                "/series/format/json",
-                params={"series_id": str(series_id)},
-            )
+            result = self._get_request("/series/format/json", params={"series_id": str(series_id)})
             if "details" in result:
                 result = result["details"]
             adapter = TypeAdapter(Series)
@@ -269,10 +263,7 @@ def get_comic(self: LeagueofComicGeeks, comic_id: int) -> Comic:
         """
         try:
             self.headers["X-API-KEY"] = self.access_token
-            result = self._get_request(
-                "/comic/format/json",
-                params={"comic_id": str(comic_id)},
-            )
+            result = self._get_request("/comic/format/json", params={"comic_id": str(comic_id)})
             adapter = TypeAdapter(Comic)
             return adapter.validate_python(result)
         except ValidationError as err: