Plugin API Reference

Scraped Data

class hircine.scraper.types.Artist(name: str)

A scraped artist.

class hircine.scraper.types.Category(value: Category)

A scraped category, represented by an enum.

class hircine.scraper.types.Censorship(value: Censorship)

A scraped censorship specifier, represented by an enum.

class hircine.scraper.types.Character(name: str)

A scraped character.

class hircine.scraper.types.Circle(name: str)

A scraped circle.

class hircine.scraper.types.Date(value: date)

A scraped date.

:param date value: The date.

classmethod from_iso(datestring)

Returns a new instance of this class given a textual representation of a date in the format YYYY-MM-DD. See datetime.date.fromisoformat().

Parameters:

datestring (str) – The string of text representing a date.

Raise:

ScrapeWarning if the date string could not be parsed.

classmethod from_timestamp(timestamp)

Returns a new instance of this class given a textual representation of a POSIX timestamp. See datetime.date.fromtimestamp().

Parameters:

timestamp (str) – The string of text representing a POSIX timestamp.

Raise:

ScrapeWarning if the timestamp could not be parsed.

class hircine.scraper.types.Direction(value: Direction)

A scraped direction, represented by an enum.

class hircine.scraper.types.Language(value: Language)

A scraped language, represented by an enum.

classmethod from_iso_639_3(string)

Returns a new instance of this class given a case-insensitive ISO 639-3 language code.

Parameters:

string (str) – The ISO 639-3 language code.

Raise:

ScrapeWarning if the language code could not be parsed.

classmethod from_name(string)

Returns a new instance of this class given a case-insensitive language name. Permissible language names are defined in hircine.enums.Language.

Parameters:

string (str) – The language name.

Raise:

ScrapeWarning if the language name could not be parsed.

class hircine.scraper.types.Layout(value: Layout)

A scraped layout, represented by an enum.

class hircine.scraper.types.OriginalTitle(value: str)

A scraped original title.

class hircine.scraper.types.Rating(value: Rating)

A scraped rating, represented by an enum.

class hircine.scraper.types.Tag(namespace: str, tag: str)

A qualified tag, represented by strings.

Parameters:

• namespace (str) – The namespace.

• tag (str) – The tag.

classmethod from_string(string, delimiter=':')

Returns a new instance of this class given a textual representation, usually a qualified tag in the format <namespace>:<tag>. If no delimiter is found, the namespace is assumed to be none and the given string is used as a tag instead.

Parameters:

• string (str) – The string of text representing a qualified tag.

• delimiter (str) – The string with which the namespace is delimited from the tag.

class hircine.scraper.types.Title(value: str)

A scraped comic title.

class hircine.scraper.types.URL(value: str)

A scraped URL.

class hircine.scraper.types.World(name: str)

A scraped world.

API Data

class hircine.api.types.FullComic(model)

archive: Archive

artists: List[Artist]

bookmarked: bool

category: Category | None

censorship: Censorship | None

characters: List[Character]

circles: List[Circle]

created_at: datetime

date: date | None

direction: Direction

favourite: bool

id: int

language: Language | None

layout: Layout

organized: bool

original_title: str | None

page_count: int

pages: List[Page]

rating: Rating | None

tags: List[ComicTag]

title: str

updated_at: datetime

url: str | None

worlds: List[World]

class hircine.api.types.Archive(model)

page_count: int

path: str

size: float

Enums

class hircine.enums.Category

ARTBOOK = 'Artbook'

COMIC = 'Comic'

DOUJINSHI = 'Doujinshi'

GAME_CG = 'Game CG'

IMAGE_SET = 'Image Set'

MANGA = 'Manga'

VARIANT_SET = 'Variant Set'

WEBTOON = 'Webtoon'

class hircine.enums.Censorship

BAR = 'Bars'

FULL = 'Full'

MOSAIC = 'Mosaic'

NONE = 'None'

class hircine.enums.Direction

LEFT_TO_RIGHT = 'Left to Right'

RIGHT_TO_LEFT = 'Right to Left'

class hircine.enums.Language

AA = 'Afar'

AB = 'Abkhazian'

AE = 'Avestan'

AF = 'Afrikaans'

AK = 'Akan'

AM = 'Amharic'

AN = 'Aragonese'

AR = 'Arabic'

AS = 'Assamese'

AV = 'Avaric'

AY = 'Aymara'

AZ = 'Azerbaijani'

BA = 'Bashkir'

BE = 'Belarusian'

BG = 'Bulgarian'

BH = 'Bihari languages'

BI = 'Bislama'

BM = 'Bambara'

BN = 'Bengali'

BO = 'Tibetan'

BR = 'Breton'

BS = 'Bosnian'

CA = 'Catalan'

CE = 'Chechen'

CH = 'Chamorro'

CO = 'Corsican'

CR = 'Cree'

CS = 'Czech'

CU = 'Church Slavic'

CV = 'Chuvash'

CY = 'Welsh'

DA = 'Danish'

DE = 'German'

DV = 'Divehi'

DZ = 'Dzongkha'

EE = 'Ewe'

EL = 'Modern Greek'

EN = 'English'

EO = 'Esperanto'

ES = 'Spanish'

ET = 'Estonian'

EU = 'Basque'

FA = 'Persian'

FF = 'Fulah'

FI = 'Finnish'

FJ = 'Fijian'

FO = 'Faroese'

FR = 'French'

FY = 'Western Frisian'

GA = 'Irish'

GD = 'Gaelic'

GL = 'Galician'

GN = 'Guarani'

GU = 'Gujarati'

GV = 'Manx'

HA = 'Hausa'

HE = 'Hebrew'

HI = 'Hindi'

HO = 'Hiri Motu'

HR = 'Croatian'

HT = 'Haitian'

HU = 'Hungarian'

HY = 'Armenian'

HZ = 'Herero'

IA = 'Interlingua'

ID = 'Indonesian'

IE = 'Interlingue'

IG = 'Igbo'

II = 'Sichuan Yi'

IK = 'Inupiaq'

IO = 'Ido'

IS = 'Icelandic'

IT = 'Italian'

IU = 'Inuktitut'

JA = 'Japanese'

JV = 'Javanese'

KA = 'Georgian'

KG = 'Kongo'

KI = 'Kikuyu'

KJ = 'Kuanyama'

KK = 'Kazakh'

KL = 'Kalaallisut'

KM = 'Central Khmer'

KN = 'Kannada'

KO = 'Korean'

KR = 'Kanuri'

KS = 'Kashmiri'

KU = 'Kurdish'

KV = 'Komi'

KW = 'Cornish'

KY = 'Kirghiz'

LA = 'Latin'

LB = 'Luxembourgish'

LG = 'Ganda'

LI = 'Limburgan'

LN = 'Lingala'

LO = 'Lao'

LT = 'Lithuanian'

LU = 'Luba-Katanga'

LV = 'Latvian'

MG = 'Malagasy'

MH = 'Marshallese'

MI = 'Maori'

MK = 'Macedonian'

ML = 'Malayalam'

MN = 'Mongolian'

MR = 'Marathi'

MS = 'Malay'

MT = 'Maltese'

MY = 'Burmese'

NA = 'Nauru'

NB = 'Norwegian Bokmål'

ND = 'North Ndebele'

NE = 'Nepali'

NG = 'Ndonga'

NL = 'Dutch'

NN = 'Norwegian Nynorsk'

NO = 'Norwegian'

NR = 'South Ndebele'

NV = 'Navajo'

NY = 'Chichewa'

OC = 'Occitan'

OJ = 'Ojibwa'

OM = 'Oromo'

OR = 'Oriya'

OS = 'Ossetian'

PA = 'Panjabi'

PI = 'Pali'

PL = 'Polish'

PS = 'Pushto'

PT = 'Portuguese'

QU = 'Quechua'

RM = 'Romansh'

RN = 'Rundi'

RO = 'Romanian'

RU = 'Russian'

RW = 'Kinyarwanda'

SA = 'Sanskrit'

SC = 'Sardinian'

SD = 'Sindhi'

SE = 'Northern Sami'

SG = 'Sango'

SI = 'Sinhala'

SK = 'Slovak'

SL = 'Slovenian'

SM = 'Samoan'

SN = 'Shona'

SO = 'Somali'

SQ = 'Albanian'

SR = 'Serbian'

SS = 'Swati'

ST = 'Southern Sotho'

SU = 'Sundanese'

SV = 'Swedish'

SW = 'Swahili'

TA = 'Tamil'

TE = 'Telugu'

TG = 'Tajik'

TH = 'Thai'

TI = 'Tigrinya'

TK = 'Turkmen'

TL = 'Tagalog'

TN = 'Tswana'

TO = 'Tonga'

TR = 'Turkish'

TS = 'Tsonga'

TT = 'Tatar'

TW = 'Twi'

TY = 'Tahitian'

UG = 'Uighur'

UK = 'Ukrainian'

UR = 'Urdu'

UZ = 'Uzbek'

VE = 'Venda'

VI = 'Vietnamese'

VO = 'Volapük'

WA = 'Walloon'

WO = 'Wolof'

XH = 'Xhosa'

YI = 'Yiddish'

YO = 'Yoruba'

ZA = 'Zhuang'

ZH = 'Chinese'

ZU = 'Zulu'

class hircine.enums.Layout

DOUBLE = 'Double Page'

DOUBLE_OFFSET = 'Double Page, offset'

SINGLE = 'Single Page'

class hircine.enums.Rating

EXPLICIT = 'Explicit'

QUESTIONABLE = 'Questionable'

SAFE = 'Safe'