
Product
Announcing Precomputed Reachability Analysis in Socket
Socket’s precomputed reachability slashes false positives by flagging up to 80% of vulnerabilities as irrelevant, with no setup and instant results.
A Python wrapper for the AnimeAPI by nattadasu with type hints and additional async support.
animeapi-python is a Python wrapper for the
AnimeAPI <https://animeapi.my.id>
__ made by
nattadasu <https://github.com/nattadasu>
__.
The wrapper is released with type hints and async support in mind for ease of use and is compatible with Python 3.6 or higher.
.. code:: sh
pip install animeapi-py
Depending on your system, you may need to use pip3
instead of
pip
, or sudo pip
instead of pip
.
Requirements
- Python 3.7 or higher
- `aiohttp <https://pypi.org/project/aiohttp/>`__ (for async support)
- `dacite <https://pypi.org/project/dacite/>`__
- `requests <https://pypi.org/project/requests/>`__
- `typing_extensions <https://pypi.org/project/typing-extensions/>`__ (for Python <= 3.8)
Usage
-----
.. code:: py
import animeapi
with animeapi.AnimeAPI() as api:
# Get anime relation data for the anime with ID 1 on MyAnimeList
mal = api.get_anime_relations(1, animeapi.Platform.MYANIMELIST)
print(mal)
# Get list of anime available on AniList
anilist = api.get_list_anime_relations(animeapi.Platform.ANILIST)
print(anilist[:2]) # Print first two results
# Get dictionary of anime available on Kitsu
kitsu = api.get_dict_anime_relations(animeapi.Platform.KITSU)
print(kitsu['1']) # Print data for Cowboy Bebop
We recommend using the ``with`` statement to create an instance of
``AnimeAPI`` as we designed the wrapper to be easy to switch between
sync and async, although you can also use ``AnimeAPI`` directly on
``sync`` methods only.
Asyncronous Usage
Similarly, for async, you just need to replace AnimeAPI
with
AsyncAnimeAPI
and use await
on the methods.
You must use the wrapper in with
statement, or you will receive
RuntimeError
exception.
.. code:: py
import animeapi
async with animeapi.AsyncAnimeAPI() as api: # Get anime relation data for the anime with ID 1 on MyAnimeList mal = await api.get_anime_relations(1, animeapi.Platform.MYANIMELIST) print(mal)
# Get list of anime available on AniList
anilist = await api.get_list_anime_relations(animeapi.Platform.ANILIST)
print(anilist[:2]) # Print first two results
# Get dictionary of anime available on Kitsu
kitsu = await api.get_dict_anime_relations(animeapi.Platform.KITSU)
print(kitsu['1']) # Print data for Cowboy Bebop
You can find the documentation for the wrapper here <https://animeapi-py.readthedocs.io/en/latest/>
__
Available Methods
``get_anime_relations(title_id: str | int, platform: str | Platform, media_type: str | TraktMediaType | TmdbMediaType | None = None, title_season: int | None) -> AnimeRelation``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This method equals to the ``/:platform/:title_id`` endpoint on the API.
.. code:: py
# Get anime relation data for the anime with ID 1 on MyAnimeList
mal = api.get_anime_relations(1, animeapi.Platform.MYANIMELIST)
print(mal)
``get_dict_anime_relations(platform: str | Platform) -> dict[str, AnimeRelation]``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This method equals to the ``/:platform`` endpoint on the API. Use this
method if you want to get complete data for all anime available on a
platform and wanted to be able to access the data by the anime ID
faster.
.. code:: py
# Get dictionary of anime available on Kitsu
kitsu = api.get_dict_anime_relations(animeapi.Platform.KITSU)
print(kitsu['1']) # Print data for Cowboy Bebop
``get_list_anime_relations(platform: str | Platform) -> list[AnimeRelation]``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This method equals to the ``/:platform()`` endpoint on the API.
.. code:: py
# Get list of anime available on AniList
anilist = api.get_list_anime_relations(animeapi.Platform.ANILIST)
print(anilist[:2]) # Print first two results
``get_list_index() -> list[AnimeRelation]``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This method equals to the ``/animeapi`` endpoint on the API.
.. code:: py
# Get list of anime available on AnimeAPI
animeapi = api.get_list_index()
print(animeapi[:2]) # Print first two results
``get_status() -> ApiStatus``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This method equals to the ``/status`` endpoint on the API.
.. code:: py
# Get status of AnimeAPI
status = api.get_status()
print(status)
``get_heartbeat() -> Heartbeat``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This method equals to the ``/heartbeat`` endpoint on the API.
.. code:: py
# Get heartbeat of AnimeAPI
heartbeat = api.get_heartbeat()
print(heartbeat)
``get_updated_time() -> Updated``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This method equals to the ``/updated`` endpoint on the API.
.. code:: py
# Get last updated time of AnimeAPI
updated = api.get_updated_time(True)
print(updated)
print(updated.datetime()) # Convert to datetime class
License
-------
``animeapi-py`` is licensed under the `GNU Affero General Public License
v3.0 <LICENSE>`__.
FAQs
A Python wrapper for the AnimeAPI by nattadasu with type hints and additional async support.
We found that animeapi-py demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket’s precomputed reachability slashes false positives by flagging up to 80% of vulnerabilities as irrelevant, with no setup and instant results.
Product
Socket is launching experimental protection for Chrome extensions, scanning for malware and risky permissions to prevent silent supply chain attacks.
Product
Add secure dependency scanning to Claude Desktop with Socket MCP, a one-click extension that keeps your coding conversations safe from malicious packages.