Skip to main content

Simple read-only Anilist API wrapper

Project description

pyanilist


Logo

Simple read-only Anilist API wrapper

Table Of Contents

About

  • Supports both sync and async.
  • Simple read-only API wrapper.
  • Only supports querying the Media type.

Installation

pyanilist is available on PyPI, so you can simply use pip to install it.

pip install pyanilist

Usage

PyAnilist offers two main classes:

  1. Anilist - Synchronous class

    • search() - Search a media

      >>> from pyanilist import Anilist, MediaType
      >>> media = Anilist().search("Attack on Titan", type=MediaType.ANIME)
      >>> media.title
      MediaTitle(romaji='Shingeki no Kyojin', english='Attack on Titan', native='進撃の巨人')
      >>> media.title.romaji
      'Shingeki no Kyojin'
      >>> media.site_url
      Url('https://anilist.co/anime/16498')
      >>> media.episodes
      25
      
    • get() - Get a media by it's Anilist ID

      >>> from pyanilist import Anilist
      >>> media = Anilist().get(21459)
      >>> media.title
      MediaTitle(romaji='Boku no Hero Academia', english='My Hero Academia', native='僕のヒーローアカデミア')
      >>> media.title.english
      'My Hero Academia'
      >>> media.site_url
      Url('https://anilist.co/anime/21459')
      >>> media.episodes
      13
      
  2. AsyncAnilist - Asynchronous class

    • search() - Search a media

      >>> import asyncio
      >>> from pyanilist import AsyncAnilist, MediaType
      >>> media = asyncio.run(AsyncAnilist().search("Attack on Titan"))
      >>> media.title
      MediaTitle(romaji='Shingeki no Kyojin', english='Attack on Titan', native='進撃の巨人')
      >>> media.title.romaji
      'Shingeki no Kyojin'
      >>> media.site_url
      Url('https://anilist.co/anime/16498')
      >>> media.episodes
      25
      
    • get() - Get a media by it's Anilist ID

      >>> import asyncio
      >>> from pyanilist import AsyncAnilist
      >>> media = asyncio.run(AsyncAnilist().get(21459))
      >>> media.title
      MediaTitle(romaji='Boku no Hero Academia', english='My Hero Academia', native='僕のヒーローアカデミア')
      >>> media.title.english
      'My Hero Academia'
      >>> media.site_url
      Url('https://anilist.co/anime/21459')
      >>> media.episodes
      13
      

API Reference

Checkout the complete API reference here.

License

Distributed under the Unlicense License. See UNLICENSE for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyanilist-0.1.0.tar.gz (15.3 kB view hashes)

Uploaded Source

Built Distribution

pyanilist-0.1.0-py3-none-any.whl (18.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page