# pyanimeinfo
[](https://pypi.org/project/pyanimeinfo/)
[](https://github.com/deepghs/pyanimeinfo/actions?query=workflow%3A%22Code+Test%22)
[](https://github.com/deepghs/pyanimeinfo/actions?query=workflow%3A%22Package+Release%22)
[](https://codecov.io/gh/deepghs/pyanimeinfo)
[](https://github.com/deepghs/pyanimeinfo/stargazers)
[](https://github.com/deepghs/pyanimeinfo/network)
[](https://github.com/deepghs/pyanimeinfo/issues)
[](https://github.com/deepghs/pyanimeinfo/pulls)
[](https://github.com/deepghs/pyanimeinfo/graphs/contributors)
[](https://github.com/deepghs/pyanimeinfo/blob/master/LICENSE)
Python anime information grabber
## Installation
You can simply install it with `pip` command line from the official PyPI site.
```shell
pip install pyanimeinfo
```
For more information about installation, you can refer
to [Installation](https://deepghs.github.io/pyanimeinfo/main/tutorials/installation/index.html).
## Quick Start
### Accessing Information from Bangumi.tv
We can retrieve information from [Bangumi.tv](https://bangumi.tv/).
```python
from pyanimeinfo.bangumitv import BangumiTVClient
client = BangumiTVClient()
# search subject from bangumi.tv
client.search_subjects('Railgun')
# query specific subject from bangumi.tv
# e.g. Railgun
client.get_subject(2585)
# list characters in this subjects
client.get_subject_characters(2585)
# query specific character
client.get_character(3575)
# list character related persons
# e.g. CV, artists
client.get_character_related_persons(3575)
# list character related subjects
# e.g. Railgun series
client.get_character_related_subjects(3575)
# get person
client.get_person(4670)
```
### Accessing Information from MyAnimeList.net
We can access information from [MyAnimeList](https://myanimelist.net/). However, since the original MyAnimeList site
does not provide a useful API, we utilize the unofficial API [Jikan V4](https://jikan.moe/) to retrieve data from
MyAnimeList.
```python
from pyanimeinfo.myanimelist import JikanV4Client
client = JikanV4Client()
# search animes
client.search_anime('Railgun')
# get specific anime
client.get_anime(6213)
# get full information of specific anime
client.get_anime_full(6213)
# get characters in specific anime
client.get_anime_characters(6213)
# search characters
client.search_anime('misaka mikoto')
# get specific character
client.get_character(13701)
# get full information of specific character
client.get_character_full(13701)
# get character related information
client.get_character_related_animes(13701)
client.get_character_related_manga(13701)
client.get_character_voice_actors(13701)
client.get_character_pictures(13701)
```
## Important Notes
1. The `pyanimeinfo` library is primarily designed for querying anime-related information and is not a comprehensive
client for bangumi.tv or any other website. Therefore, we currently do not plan to provide support for operations
like user authentication and user sessions in the short term. Your understanding is appreciated.
2. The reason this library is not named `pybangumitv` is that our intention is not limited to integrating only the
bangumi.tv website. In the future, we aim to introduce support for additional websites, including MyAnimeList,
Fandom, and others. Stay tuned for updates.
Raw data
{
"_id": null,
"home_page": "https://github.com/deepghs/pyanimeinfo",
"name": "pyanimeinfo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Python anime information grabber.",
"author": "narugo1992",
"author_email": "narugo992@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2d/70/223b28b06c0f21f5634e3a20728ca035d012d6d34730a1d80aa051ba8f94/pyanimeinfo-0.0.2.tar.gz",
"platform": null,
"description": "# pyanimeinfo\n\n[](https://pypi.org/project/pyanimeinfo/)\n\n\n\n\n[](https://github.com/deepghs/pyanimeinfo/actions?query=workflow%3A%22Code+Test%22)\n[](https://github.com/deepghs/pyanimeinfo/actions?query=workflow%3A%22Package+Release%22)\n[](https://codecov.io/gh/deepghs/pyanimeinfo)\n\n\n[](https://github.com/deepghs/pyanimeinfo/stargazers)\n[](https://github.com/deepghs/pyanimeinfo/network)\n\n[](https://github.com/deepghs/pyanimeinfo/issues)\n[](https://github.com/deepghs/pyanimeinfo/pulls)\n[](https://github.com/deepghs/pyanimeinfo/graphs/contributors)\n[](https://github.com/deepghs/pyanimeinfo/blob/master/LICENSE)\n\nPython anime information grabber\n\n## Installation\n\nYou can simply install it with `pip` command line from the official PyPI site.\n\n```shell\npip install pyanimeinfo\n```\n\nFor more information about installation, you can refer\nto [Installation](https://deepghs.github.io/pyanimeinfo/main/tutorials/installation/index.html).\n\n## Quick Start\n\n### Accessing Information from Bangumi.tv\n\nWe can retrieve information from [Bangumi.tv](https://bangumi.tv/).\n\n```python\nfrom pyanimeinfo.bangumitv import BangumiTVClient\n\nclient = BangumiTVClient()\n\n# search subject from bangumi.tv\nclient.search_subjects('Railgun')\n\n# query specific subject from bangumi.tv\n# e.g. Railgun\nclient.get_subject(2585)\n\n# list characters in this subjects\nclient.get_subject_characters(2585)\n\n# query specific character\nclient.get_character(3575)\n\n# list character related persons\n# e.g. CV, artists\nclient.get_character_related_persons(3575)\n\n# list character related subjects\n# e.g. Railgun series\nclient.get_character_related_subjects(3575)\n\n# get person\nclient.get_person(4670)\n```\n\n### Accessing Information from MyAnimeList.net\n\nWe can access information from [MyAnimeList](https://myanimelist.net/). However, since the original MyAnimeList site\ndoes not provide a useful API, we utilize the unofficial API [Jikan V4](https://jikan.moe/) to retrieve data from\nMyAnimeList.\n\n```python\nfrom pyanimeinfo.myanimelist import JikanV4Client\n\nclient = JikanV4Client()\n\n# search animes\nclient.search_anime('Railgun')\n\n# get specific anime\nclient.get_anime(6213)\n\n# get full information of specific anime\nclient.get_anime_full(6213)\n\n# get characters in specific anime\nclient.get_anime_characters(6213)\n\n# search characters\nclient.search_anime('misaka mikoto')\n\n# get specific character\nclient.get_character(13701)\n\n# get full information of specific character\nclient.get_character_full(13701)\n\n# get character related information\nclient.get_character_related_animes(13701)\nclient.get_character_related_manga(13701)\nclient.get_character_voice_actors(13701)\nclient.get_character_pictures(13701)\n\n```\n\n## Important Notes\n\n1. The `pyanimeinfo` library is primarily designed for querying anime-related information and is not a comprehensive\n client for bangumi.tv or any other website. Therefore, we currently do not plan to provide support for operations\n like user authentication and user sessions in the short term. Your understanding is appreciated.\n\n2. The reason this library is not named `pybangumitv` is that our intention is not limited to integrating only the\n bangumi.tv website. In the future, we aim to introduce support for additional websites, including MyAnimeList,\n Fandom, and others. Stay tuned for updates.\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Python anime information grabber.",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/deepghs/pyanimeinfo"
},
"split_keywords": [
"python",
"anime",
"information",
"grabber."
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1cebb1b003c5e78158fc8570b60ed76699e1e5d1f0b626dc65140c811a103cbe",
"md5": "f67c0c87e2eaebb6ca610e8d7cb78a7e",
"sha256": "3b19461051ed889d93abac9bd8758e38e8227a08ea8365cb899d2ada416b09f5"
},
"downloads": -1,
"filename": "pyanimeinfo-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f67c0c87e2eaebb6ca610e8d7cb78a7e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 18266,
"upload_time": "2023-12-30T06:20:20",
"upload_time_iso_8601": "2023-12-30T06:20:20.029157Z",
"url": "https://files.pythonhosted.org/packages/1c/eb/b1b003c5e78158fc8570b60ed76699e1e5d1f0b626dc65140c811a103cbe/pyanimeinfo-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2d70223b28b06c0f21f5634e3a20728ca035d012d6d34730a1d80aa051ba8f94",
"md5": "86c534ca537e592eaba316ea0cfa7842",
"sha256": "41b3eb7108191611aff6ed311710412963df7aaca25cd721bea2929b769a5edd"
},
"downloads": -1,
"filename": "pyanimeinfo-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "86c534ca537e592eaba316ea0cfa7842",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17839,
"upload_time": "2023-12-30T06:20:21",
"upload_time_iso_8601": "2023-12-30T06:20:21.412170Z",
"url": "https://files.pythonhosted.org/packages/2d/70/223b28b06c0f21f5634e3a20728ca035d012d6d34730a1d80aa051ba8f94/pyanimeinfo-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-30 06:20:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deepghs",
"github_project": "pyanimeinfo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyanimeinfo"
}
JSON
