comicgeeks package

Submodules

comicgeeks.Comic_Geeks module

class comicgeeks.Comic_Geeks.Comic_Geeks(ci_session: Optional[str] = None)

Bases: object

League of Comic Geeks client

ci_session

Cookie ci_session of League of Comic Geeks

Type:

str

character_info(character_id: int) → Character

Get character info by id

Parameters:

character_id (int) – character id

Returns:

Character object

Return type:

Character

creator_info(creator_id: int) → Creator

Get creator info by id

Parameters:

creator_id (int) – creator id

Returns:

Creator object

Return type:

Creator

issue_info(issue_id: int) → Issue

Get issue info by id

Parameters:

issue_id (int) – issue id

Returns:

Issue object

Return type:

Issue

new_releases(date: datetime = 'now') → list[comicgeeks.classes.Issue]

Get this week new releases

Parameters:

date (datetime) – Date to get new releases

Returns:

List of issues

Return type:

list (Issue)

search_character(query: str) → list[comicgeeks.classes.Character]

search_creator(query: str) → list[comicgeeks.classes.Creator]

Search series by name

Parameters:

query (str) – Series name

Returns:

List of series

Return type:

list (Series)

search_series(query: str) → list[comicgeeks.classes.Series]

Search series by name

Parameters:

query (str) – Series name

Returns:

List of series

Return type:

list (Series)

series_info(series_id: int) → Series

Get series info by id

Parameters:

series_id (int) – series id

Returns:

Series class

Return type:

Series

comicgeeks.classes module

class comicgeeks.classes.Character(character_id: int, ci_session: Optional[str] = None)

Bases: object

Character class

property also_known_as: list

Other character personalities

property character_id: str

Character id

property creators: list

Character creators

property description: str

Character description

property image: str

Character image

property information: list

Information about the character

property issue_count: int

Issues with this character

json() → dict

Return data in json format

property name: str

Character real name

property owned: int

Issues with this character owned

property publisher: str

Character publisher

property read: int

Issues with this character read

property real_name: str

Character real name

property series: list

Series in which the character appears

property universe: str

Character universe

property url: str

Character url

class comicgeeks.classes.Creator(creator_id: int, ci_session: Optional[str] = None)

Bases: object

Creator class

property characters: list

Credited characters

property creator_id: list

Creator id

property description: list

Creator description

property image: list

Creator image

property issue_count: int

Number of issues made by this creator

json() → dict

Return data in json format

property name: list

Creator name

property owned: int

Issues by this creator owned

property read: int

Issues by this creator read

property series: list

Credited series

property url: list

Creator url

class comicgeeks.classes.Issue(issue_id: int, ci_session: Optional[str] = None)

Bases: object

ComicGeeks Issue class

add_to_collection() → dict

Add issue to collection

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

add_to_wishlist() → dict

Add series to wishlist

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

property characters: list

List of characters that appear in this issue

property community: dict

Dictionary with community data

Parameters:

• pull (int|str) – Number of pulls or “Unknown” if the issue was already released,

• collect (int) – Number of users who have it,

• readlist (int) – Number of user who read it,

• wishlist (int) – Number of user who have it in their wishlist,

• rating (int) – Rating

property cover: dict

Issue cover

property description: str

Issue description

property details: dict

Issue details

Parameters:

• format (str) – Issue format,

• page_count (str) – Number of pages,

• upc (str?) – UPC code,

• distributor_sku (str?) – SKU code,

property issue_id: int

Issue id

json() → dict

Return data in json format

mark_read() → dict

Mark issue as read

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

property name: str

Issue name

property number: str

Issue number

property person_credits: list

List of people that create this issue

property price: float

Issue price

property publisher: str

Publisher name

pull() → dict

Pull issue

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

rate(score: int) → dict

Rate issue

Parameters:

score (int) – number from 0 to 5

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

remove_from_collection() → dict

Remove series from collection

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

remove_from_readlist() → dict

Mark issue as unread

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

remove_from_wishlist() → dict

Remove series from wishlist

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

property series_pagination: dict

Issue pagination

Parameters:

• prev (Issue) – previous issue

• series (Series) – series

• next (Issue) – next issue

property store_date: int

Issue store date

unsubscribe() → dict

Unsubscribe issue

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

property url: str

Issue url

property user: dict

Dictionary with user data

Parameters:

• pull (bool) – Is the issue in the pull list?,

• collect (bool) – Is the issue in the collection?,

• readlist (bool) – Is the issue in the read list?,

• wishlist (bool) – Is the issue in the wishlist?,

• rating (int) – User rating from 0 to 5

property variant_covers: list

List of variant covers

class comicgeeks.classes.Series(series_id: int, ci_session: Optional[str] = None)

Bases: object

ComicGeeks Series class

add_missing_to_wishlist() → dict

Add missing issues to wishlist

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

add_to_collection() → dict

Add series to collection

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

add_to_wishlist() → dict

Add series to wishlist

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

property cover: str

Series cover url

property description: str

Series description

property end_year: int

Year when the series ended

property issue_count: int

Number of issues

property issues: list

List of issues of the series

json() → dict

Return data in json format

mark_owned_read() → dict

Mark owned issues as read

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

mark_read() → dict

Mark series as read

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

property name: str

Series name

property publisher: str

Publisher name

pull() → dict

Pull series

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

pull_hc() → dict

Pull only hard cover issues

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

pull_tp() → dict

Pull only trade paperback issues

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

remove_from_collection() → dict

Remove series from collection

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

remove_from_readlist() → dict

Mark series as unread

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

remove_from_wishlist() → dict

Remove series from wishlist

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

property series_id: int

Series id

property start_year: int

Year when the series started

unsubscribe() → dict

Unsubscribe series

Returns:

{“text”: “”, “type”: “error|success”}

Return type:

dict

property url: str

Series url

property user: dict

Dictionary with user data

Parameters:

• pull (bool) – Is the series in the pull list?,

• owned (str) – Is the issue in the collection?,

• read (str) – Is the issue in the read list?

comicgeeks.extract module

This module contains functions for extracting and parsing details out of comic book filenames.

@author: cbanack

comicgeeks.extract.extract(name_s)

Takes the filename of a comic book, and extracts three strings out of it: the series name, the issue number, and the issue year. These three pieces of information are returned as a triple, i.e. (“batman”, “344”, “2004”).

This function never returns None, and it will ALWAYS return the triple with at least a non-empty series name (even if it is just “unknown”), but the issue number and year may be “” if they couldn’t be determined.

comicgeeks.extract.regex(filename_s, regex_s)

Takes the filename of a comic book, and extracts three strings out of it using the given regular expression, which must match the filename and create regex groups called “series”, “num”, and “year”. The extracted details will be the series name, the issue number, and the issue year. These three details are returned as a triple, i.e. (“batman”, “344”, “2004”).

As long as AT LEAST a series name is found, this function will return the triple (missing values will be “”). Otherwise, it returns None.

comicgeeks.utils module

comicgeeks.utils.get_characters(content, Character, ci_session)

comicgeeks.utils.get_series(content, Series, ci_session)

Module contents