animedex.backends.shikimori

High-level Shikimori Python API.

• animedex.backends.shikimori.models
  • ShikimoriImage
    • ShikimoriImage
  • ShikimoriEntity
    • ShikimoriEntity
  • ShikimoriStudio
    • ShikimoriStudio
  • ShikimoriPublisher
    • ShikimoriPublisher
  • ShikimoriVideo
    • ShikimoriVideo
  • ShikimoriScreenshot
    • ShikimoriScreenshot
  • ShikimoriCharacter
    • ShikimoriCharacter
  • ShikimoriPerson
    • ShikimoriPerson
  • ShikimoriManga
    • ShikimoriManga
  • ShikimoriClubLogo
    • ShikimoriClubLogo
  • ShikimoriUserImage
    • ShikimoriUserImage
  • ShikimoriUser
    • ShikimoriUser
  • ShikimoriClub
    • ShikimoriClub
  • ShikimoriRole
    • ShikimoriRole
  • ShikimoriAnime
    • ShikimoriAnime
  • ShikimoriCalendarEntry
    • ShikimoriCalendarEntry
  • ShikimoriTopic
    • ShikimoriTopic
  • ShikimoriResource
    • ShikimoriResource
  • selftest
    • selftest()

calendar

animedex.backends.shikimori.calendar(*, page: int | None = None, limit: int | None = None, censored: str | None = None, config: Config | None = None, **kw) → List[ShikimoriCalendarEntry]

Upcoming and currently airing schedule via /api/calendar.

search

animedex.backends.shikimori.search(q: str | None = None, *, page: int | None = None, limit: int = 10, order: str | None = None, kind: str | None = None, status: str | None = None, season: str | None = None, rating: str | None = None, censored: str | None = None, config: Config | None = None, **kw) → List[ShikimoriAnime]

Search anime via /api/animes.

show

animedex.backends.shikimori.show(anime_id: int, *, config: Config | None = None, **kw) → ShikimoriAnime

Fetch one anime by Shikimori ID.

manga_search

animedex.backends.shikimori.manga_search(q: str | None = None, *, page: int | None = None, limit: int = 10, order: str | None = None, kind: str | None = None, status: str | None = None, season: str | None = None, censored: str | None = None, config: Config | None = None, **kw) → List[ShikimoriManga]

Search manga via /api/mangas.

manga_show

animedex.backends.shikimori.manga_show(manga_id: int, *, config: Config | None = None, **kw) → ShikimoriManga

Fetch one manga by Shikimori ID.

ranobe_search

animedex.backends.shikimori.ranobe_search(q: str | None = None, *, page: int | None = None, limit: int = 10, order: str | None = None, kind: str | None = None, status: str | None = None, season: str | None = None, censored: str | None = None, config: Config | None = None, **kw) → List[ShikimoriManga]

Search ranobe via /api/ranobe.

ranobe_show

animedex.backends.shikimori.ranobe_show(ranobe_id: int, *, config: Config | None = None, **kw) → ShikimoriManga

Fetch one ranobe by Shikimori ID.

club_search

animedex.backends.shikimori.club_search(q: str | None = None, *, page: int | None = None, limit: int = 10, config: Config | None = None, **kw) → List[ShikimoriClub]

Search clubs via /api/clubs.

club_show

animedex.backends.shikimori.club_show(club_id: int, *, config: Config | None = None, **kw) → ShikimoriClub

Fetch one club by Shikimori ID.

character_search

animedex.backends.shikimori.character_search(q: str | None = None, *, limit: int | None = None, config: Config | None = None, **kw) → List[ShikimoriCharacter]

Search top-level characters via /api/characters/search.

character

animedex.backends.shikimori.character(character_id: int, *, config: Config | None = None, **kw) → ShikimoriCharacter

Fetch one top-level character by Shikimori ID.

publishers

animedex.backends.shikimori.publishers(*, config: Config | None = None, **kw) → List[ShikimoriPublisher]

List Shikimori manga publishers.

publisher

animedex.backends.shikimori.publisher(publisher_id: int, *, config: Config | None = None, **kw) → ShikimoriPublisher

Fetch one publisher from the Shikimori publisher catalogue.

people_search

animedex.backends.shikimori.people_search(q: str | None = None, *, limit: int | None = None, config: Config | None = None, **kw) → List[ShikimoriPerson]

Search top-level people via /api/people/search.

person

animedex.backends.shikimori.person(person_id: int, *, config: Config | None = None, **kw) → ShikimoriPerson

Fetch one top-level person by Shikimori ID.

screenshots

animedex.backends.shikimori.screenshots(anime_id: int, *, config: Config | None = None, **kw) → List[ShikimoriScreenshot]

List screenshots for one anime.

videos

animedex.backends.shikimori.videos(anime_id: int, *, config: Config | None = None, **kw) → List[ShikimoriVideo]

List promo and episode-preview videos for one anime.

roles

animedex.backends.shikimori.roles(anime_id: int, *, config: Config | None = None, **kw) → List[ShikimoriResource]

List role rows for one anime.

characters

animedex.backends.shikimori.characters(anime_id: int, *, config: Config | None = None, **kw) → List[ShikimoriCharacter]

List character references for one anime.

staff

animedex.backends.shikimori.staff(anime_id: int, *, config: Config | None = None, **kw) → List[ShikimoriPerson]

List staff and voice-person references for one anime.

similar

animedex.backends.shikimori.similar(anime_id: int, *, config: Config | None = None, **kw) → List[ShikimoriAnime]

List anime similar to one anime.

related

animedex.backends.shikimori.related(anime_id: int, *, config: Config | None = None, **kw) → List[ShikimoriResource]

List related anime/manga/franchise rows for one anime.

external_links

animedex.backends.shikimori.external_links(anime_id: int, *, config: Config | None = None, **kw) → List[ShikimoriResource]

List external links for one anime.

topics

animedex.backends.shikimori.topics(anime_id: int, *, page: int | None = None, limit: int | None = None, kind: str | None = None, episode: int | None = None, config: Config | None = None, **kw) → List[ShikimoriTopic]

List discussion topics for one anime.

studios

animedex.backends.shikimori.studios(*, config: Config | None = None, **kw) → List[ShikimoriStudio]

List Shikimori studios.

studio

animedex.backends.shikimori.studio(studio_id: int, *, config: Config | None = None, **kw) → ShikimoriStudio

Fetch one studio from the Shikimori studio catalogue.

genres

animedex.backends.shikimori.genres(*, config: Config | None = None, **kw) → List[ShikimoriResource]

List Shikimori genres.

selftest

animedex.backends.shikimori.selftest() → bool

Smoke-test the Shikimori high-level package.