Metadata-Version: 2.1
Name: askitsu
Version: 1.0.0
Summary: An async API wrapper for Kitsu.io
Home-page: https://github.com/ShomyKohai/askitsu
License: MIT
Keywords: kitsu,kitsu api,kitsu.io,async
Author: ShomyKohai
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Dist: aiohttp (>=3.6.0,<4.0.0)
Requires-Dist: colorama (>=0.4.6,<0.5.0)
Project-URL: Bug Tracker, https://github.com/ShomyKohai/askitsu/issues
Project-URL: Documentation, https://askitsu.rtfd.org/
Project-URL: Repository, https://github.com/ShomyKohai/askitsu
Description-Content-Type: text/markdown

<h1  align="center">
askitsu
</h1>

[![TwitterShomy](https://img.shields.io/badge/-shomykohai-1DA1F2?style=flat&logo=twitter&logoColor=white&labelColor=1DA1F2)](https://twitter.com/shomykohai)
[![askitsu](https://img.shields.io/pypi/v/askitsu?label=askitsu&logo=pypi&logoColor=white&labelColor=blue&color=9cf)](https://pypi.org/project/askitsu/)
[![Documentation Status](https://readthedocs.org/projects/askitsu/badge/?version=master)](https://askitsu.readthedocs.io/en/master/?badge=master)

<p align="center">
  An async wrapper for Kitsu.io API written in Python
</p>

![askitsu](https://github.com/ShomyKohai/askitsu/blob/master/docs/images/dark.png?raw=true "askitsu")
  

# IMPORTANT

💡 UPDATE:<br>
The master branch is now in a status where it can be used.<br>
For any issue you may encounter, please make a new [issue](https://github.com/ShomyKohai/askitsu/issues).<br>
You can check the [projects](https://github.com/ShomyKohai/askitsu/projects?type=classic) tab to see current progress.

# Key features

- Fully typed
- Use of `async`/`await`
- Support most of primary Kitsu entries -- Anime, Manga, Characters and much more
- Can be used with discord bots

# Currently avaiable endpoints

- 🎞️ Anime (Anime, Episodes and Streaming Links)
- 📖 Manga (Manga and Chapters)
- 👥 Characters
- 📰 Reviews
- 👤 User (Profile and Profile Links)
- 🗞️ Posts
- 📚 User Libraries

Coming soon:

- 🗨️ Comments

# Installing

Requires python 3.8+

To install the package, you can simply run

```py

#Linux/MacOS
python3 -m pip install askitsu


#Windows
py -3 -m pip install askitsu

```

Or to get the latest dev version

```py

#Linux/MacOS
python3 -m pip install git+https://github.com/ShomyKohai/askitsu.git

  

#Windows
py -3 -m pip install git+https://github.com/ShomyKohai/askitsu.git

```

## Requirements

- [aiohttp](https://pypi.org/project/aiohttp/)
- [colorama](https://pypi.org/project/colorama/)

# Examples

```py
import askitsu
import asyncio

async def search():
    client = askitsu.Client()
    anime = await client.search_anime("attack on titan")
    print(anime.episode_count)
    print(anime.status)
    await client.close()

loop = asyncio.get_event_loop()
loop.run_until_complete(search())

```

More examples can be found inside the example directory -> [Here](https://github.com/ShomyKohai/askitsu/tree/master/examples)

# Links & Credits

- [Docs](https://askitsu.readthedocs.io/)
- [PyPi](https://pypi.org/project/askitsu/)
- [Kitsu.io Docs](https://kitsu.io/api/playground)
- [discord.py](https://github.com/Rapptz/discord.py) (bot example)

__"Kitsu" name and the "Kitsu logo" are property of [Kitsu](https://kitsu.io/)__

