kitsu-py


Namekitsu-py JSON
Version 1.1.2 PyPI version JSON
download
home_pagehttps://github.com/MrArkon/kitsu.py/
SummaryA Simple & Lightweight Asynchronous Python Wrapper for Kitsu's Manga & Anime API.
upload_time2023-01-17 11:39:13
maintainerMrArkon
docs_urlNone
authorMrArkon
requires_python>=3.8,<4.0
licenseMIT
keywords kitsu async kitsu kitsu.py kitsu api wrapper
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">Kitsu.py</h1>

<div align="center">
  <strong>Python API wrapper for kitsu.io</strong>
</div>
<div align="center">
  A Simple & Lightweight Asynchronous Python Wrapper for Kitsu’s Manga & Anime API.
</div>

<br />


<div align="center">
  <!-- License -->
  <a href="https://github.com/MrArkon/kitsu.py/blob/master/LICENSE">
    <img src="https://img.shields.io/pypi/l/kitsu.py?label=License&style=flat-square"
      alt="License" />
  </a>
  <!-- Code Quality -->
  <a href="https://www.codacy.com/gh/MrArkon/Kitsu.py/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=MrArkon/Kitsu.py&amp;utm_campaign=Badge_Grad">
    <img src="https://img.shields.io/codacy/grade/a04e4a4edbb84f6ea6d0c5a091a912a5?label=Code%20Quality&style=flat-square" />
  </a>
  <!-- Downloads -->
   <img src="https://img.shields.io/pypi/dm/Kitsu.py?label=Downloads&style=flat-square" />
  <!-- PyPi Version -->
  <a href="https://pypi.python.org/pypi/kitsu.py">
      <img src="https://img.shields.io/pypi/v/Kitsu.py?label=PyPi&style=flat-square" />
  </a>
  <!-- PyPi Version -->
  <img src="https://img.shields.io/pypi/pyversions/Kitsu.py?label=Python&style=flat-square" />
</div>

<div align="center">
  <h3>
    <a href="https://kitsu-py.readthedocs.io/">
      Documentation
    </a>
    <span> | </span>
    <a href="https://pypi.org/project/Kitsu.py/">
      Project Page
    </a>
    <span> | </span>
    <a href="https://github.com/MrArkon/Kitsu.py/blob/master/CHANGELOG.md">
        Changelog
    </a>
  </h3>
</div>


## Features
* **Simple and Modern** — Simple and Modern Pythonic API using `async/await`.
* **Typed** — Fully typed to provide a smooth experience while programming.
* **Features** — Get information about Categories, Episodes, Streaming Links and a lot more!
* **Custom Search** — Find any Anime/Manga using Filters or Trending Animes & Mangas.

## Requirements

Python 3.8+
* [aiohttp](https://pypi.org/project/aiohttp/)
* [python-dateutil](https://pypi.org/project/python-dateutil)

## Installing
To install the library, run the following commands:
```shell
# Linux/MacOS
python3 -m pip install -U kitsu.py

# Windows
py -3 -m pip install -U kitsu.py
```

## Example

Search for an anime:
```python
import kitsu
import asyncio

client = kitsu.Client()

async def main():
    # Search a specific anime with the name
    anime = await client.search_anime("jujutsu kaisen", limit=1)
    
    print("Canonical Title: " + anime.canonical_title)
    print("Average Rating: " + str(anime.average_rating))
    
    # This returns a list of 5 animes in the spring season 2022
    animes_in_spring = await client.search_anime(limit=5, season_year=2022, season='spring')
    
    print(*[a.title for a in animes_in_spring], sep=", ")
    
    # Close the internal aiohttp ClientSession
    await client.close()

loop = asyncio.get_event_loop()
loop.run_until_complete(main())
```
This prints:
```
Canonical Title: Jujutsu Kaisen
Average Rating: 85.98
That Time I Got Reincarnated as a Slime: Ramiris to the Rescue, Blue Thermal, Q&A=E, Smol Adventures, Estab-Life: Great Escape
```
You can find more examples in the [examples](https://github.com/MrArkon/kitsu.py/tree/master/examples/) directory.

## License

This project is distributed under the [MIT](https://github.com/MrArkon/kitsu.py/blob/master/LICENSE.txt) license.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/MrArkon/kitsu.py/",
    "name": "kitsu-py",
    "maintainer": "MrArkon",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "mrarkon@outlook.com",
    "keywords": "kitsu,async kitsu,kitsu.py,kitsu api wrapper",
    "author": "MrArkon",
    "author_email": "mrarkon@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/af/f0/0f0478212d32f2acb12fb4bd69ccb6857317d0eef3dbbbe3ad2bc7faacb0/kitsu_py-1.1.2.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">Kitsu.py</h1>\n\n<div align=\"center\">\n  <strong>Python API wrapper for kitsu.io</strong>\n</div>\n<div align=\"center\">\n  A Simple & Lightweight Asynchronous Python Wrapper for Kitsu\u2019s Manga & Anime API.\n</div>\n\n<br />\n\n\n<div align=\"center\">\n  <!-- License -->\n  <a href=\"https://github.com/MrArkon/kitsu.py/blob/master/LICENSE\">\n    <img src=\"https://img.shields.io/pypi/l/kitsu.py?label=License&style=flat-square\"\n      alt=\"License\" />\n  </a>\n  <!-- Code Quality -->\n  <a href=\"https://www.codacy.com/gh/MrArkon/Kitsu.py/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=MrArkon/Kitsu.py&amp;utm_campaign=Badge_Grad\">\n    <img src=\"https://img.shields.io/codacy/grade/a04e4a4edbb84f6ea6d0c5a091a912a5?label=Code%20Quality&style=flat-square\" />\n  </a>\n  <!-- Downloads -->\n   <img src=\"https://img.shields.io/pypi/dm/Kitsu.py?label=Downloads&style=flat-square\" />\n  <!-- PyPi Version -->\n  <a href=\"https://pypi.python.org/pypi/kitsu.py\">\n      <img src=\"https://img.shields.io/pypi/v/Kitsu.py?label=PyPi&style=flat-square\" />\n  </a>\n  <!-- PyPi Version -->\n  <img src=\"https://img.shields.io/pypi/pyversions/Kitsu.py?label=Python&style=flat-square\" />\n</div>\n\n<div align=\"center\">\n  <h3>\n    <a href=\"https://kitsu-py.readthedocs.io/\">\n      Documentation\n    </a>\n    <span> | </span>\n    <a href=\"https://pypi.org/project/Kitsu.py/\">\n      Project Page\n    </a>\n    <span> | </span>\n    <a href=\"https://github.com/MrArkon/Kitsu.py/blob/master/CHANGELOG.md\">\n        Changelog\n    </a>\n  </h3>\n</div>\n\n\n## Features\n* **Simple and Modern** \u2014 Simple and Modern Pythonic API using `async/await`.\n* **Typed** \u2014 Fully typed to provide a smooth experience while programming.\n* **Features** \u2014 Get information about Categories, Episodes, Streaming Links and a lot more!\n* **Custom Search** \u2014 Find any Anime/Manga using Filters or Trending Animes & Mangas.\n\n## Requirements\n\nPython 3.8+\n* [aiohttp](https://pypi.org/project/aiohttp/)\n* [python-dateutil](https://pypi.org/project/python-dateutil)\n\n## Installing\nTo install the library, run the following commands:\n```shell\n# Linux/MacOS\npython3 -m pip install -U kitsu.py\n\n# Windows\npy -3 -m pip install -U kitsu.py\n```\n\n## Example\n\nSearch for an anime:\n```python\nimport kitsu\nimport asyncio\n\nclient = kitsu.Client()\n\nasync def main():\n    # Search a specific anime with the name\n    anime = await client.search_anime(\"jujutsu kaisen\", limit=1)\n    \n    print(\"Canonical Title: \" + anime.canonical_title)\n    print(\"Average Rating: \" + str(anime.average_rating))\n    \n    # This returns a list of 5 animes in the spring season 2022\n    animes_in_spring = await client.search_anime(limit=5, season_year=2022, season='spring')\n    \n    print(*[a.title for a in animes_in_spring], sep=\", \")\n    \n    # Close the internal aiohttp ClientSession\n    await client.close()\n\nloop = asyncio.get_event_loop()\nloop.run_until_complete(main())\n```\nThis prints:\n```\nCanonical Title: Jujutsu Kaisen\nAverage Rating: 85.98\nThat Time I Got Reincarnated as a Slime: Ramiris to the Rescue, Blue Thermal, Q&A=E, Smol Adventures, Estab-Life: Great Escape\n```\nYou can find more examples in the [examples](https://github.com/MrArkon/kitsu.py/tree/master/examples/) directory.\n\n## License\n\nThis project is distributed under the [MIT](https://github.com/MrArkon/kitsu.py/blob/master/LICENSE.txt) license.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Simple & Lightweight Asynchronous Python Wrapper for Kitsu's Manga & Anime API.",
    "version": "1.1.2",
    "split_keywords": [
        "kitsu",
        "async kitsu",
        "kitsu.py",
        "kitsu api wrapper"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dc1a28bdd32c1fd83ed4f28fd4305f9a03bdca7b665a604f403523878aab1448",
                "md5": "d4f4fd56da22c0ecc293ccf42a46f5a6",
                "sha256": "d8c805515073ea1a0169b86b61d4efe5328e64642ee10c87a356db091548a49b"
            },
            "downloads": -1,
            "filename": "kitsu_py-1.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d4f4fd56da22c0ecc293ccf42a46f5a6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 12180,
            "upload_time": "2023-01-17T11:39:10",
            "upload_time_iso_8601": "2023-01-17T11:39:10.592693Z",
            "url": "https://files.pythonhosted.org/packages/dc/1a/28bdd32c1fd83ed4f28fd4305f9a03bdca7b665a604f403523878aab1448/kitsu_py-1.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aff00f0478212d32f2acb12fb4bd69ccb6857317d0eef3dbbbe3ad2bc7faacb0",
                "md5": "9d06d2f5d757f4dd6c0376c7c90bf81a",
                "sha256": "4cfc73a74ce2cba5fdf44bc76094c3d0ffd8a821de02c2976a85b5673cdb5f65"
            },
            "downloads": -1,
            "filename": "kitsu_py-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "9d06d2f5d757f4dd6c0376c7c90bf81a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 9288,
            "upload_time": "2023-01-17T11:39:13",
            "upload_time_iso_8601": "2023-01-17T11:39:13.789520Z",
            "url": "https://files.pythonhosted.org/packages/af/f0/0f0478212d32f2acb12fb4bd69ccb6857317d0eef3dbbbe3ad2bc7faacb0/kitsu_py-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-17 11:39:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "MrArkon",
    "github_project": "kitsu.py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "kitsu-py"
}
        
Elapsed time: 0.03236s