diff --git a/darkseid/utils.py b/darkseid/utils.py index 22977be..994b8d9 100644 --- a/darkseid/utils.py +++ b/darkseid/utils.py @@ -11,9 +11,26 @@ # TODO: Change to StrEnum when Python-3.10 support dropped class DataSources(str, Enum): + """Enumeration for various comic data sources. + + This class defines a set of constants representing different sources of comic data. + Each constant is a string that corresponds to a specific data source name. + + Attributes: + COMIC_VINE (str): Represents the Comic Vine data source. + METRON (str): Represents the Metron data source. + GCD (str): Represents the Grand Comics Database data source. + KITSU (str): Represents the Kitsu data source. + MANGADEX (str): Represents the MangaDex data source. + MANGAUPDATES (str): Represents the MangaUpdates data source. + """ + COMIC_VINE = "Comic Vine" METRON = "Metron" GCD = "Grand Comics Database" + KITSU = "Kitsu" + MANGADEX = "MangaDex" + MANGAUPDATES = "MangaUpdates" def get_issue_id_from_note(note_txt: str) -> dict[str, str] | None: @@ -41,6 +58,9 @@ def get_issue_id_from_note(note_txt: str) -> dict[str, str] | None: "comic vine": DataSources.COMIC_VINE, "metron": DataSources.METRON, "grand comics database": DataSources.GCD, + "mangadex": DataSources.MANGADEX, + "mangaupdates": DataSources.MANGAUPDATES, + "kitsu": DataSources.KITSU, } if match := re.search(r"(issue id (\d+))|(cvdb(\d+))", note_lower): diff --git a/docs/darkseid/utils.md b/docs/darkseid/utils.md index 9edccb4..8808b8e 100644 --- a/docs/darkseid/utils.md +++ b/docs/darkseid/utils.md @@ -1,3 +1,5 @@ +:::darkseid.utils.DataSources +:::darkseid.utils.get_issue_id_from_note :::darkseid.utils.get_recursive_filelist :::darkseid.utils.list_to_string :::darkseid.utils.remove_articles