https://github.com/metastag/kitsupy
A simple api wrapper for the kitsu api written in python
https://github.com/metastag/kitsupy
anime api-wrapper kitsu python
Last synced: 12 months ago
JSON representation
A simple api wrapper for the kitsu api written in python
- Host: GitHub
- URL: https://github.com/metastag/kitsupy
- Owner: MetaStag
- License: mit
- Created: 2021-06-10T08:33:45.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-10T13:20:19.000Z (almost 5 years ago)
- Last Synced: 2025-03-17T13:41:34.893Z (about 1 year ago)
- Topics: anime, api-wrapper, kitsu, python
- Language: Python
- Homepage: https://pypi.org/project/kitsupy/
- Size: 10.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
**[As of March 2025, this project is officially archived, as it has been unmaintained for years, there's no guarantee it will work anymore, proceed at your own risk]**
# kitsupy
kitsupy is a simple api wrapper for the [kitsu](https://kitsu.io/explore/anime) api written in python. It should work without any problems on any reasonably recent version of python.
### Installation
kitsupy can be installed from pypi
```bash
$ pip install kitsupy
```
### Dependencies
This module requires only one external module, `requests`, which should be installed by-default with python. In case it's not, you can install it with pip:
```bash
$ pip install requests
```
Note that when you install `kitsupy`, it automatically checks whether you have `requests` installed and if not, it installs it automatically, so you technically don't have to do anything.
### Example
```py
>>> import kitsupy # import the module
>>> kitsupy.search('anime', 'bakemonogatari')
{'count': 2, '3919': 'Bakemonogatari', '4800': 'Bakemonogatari Recap'}
>>> # A dictionary is returned, from where we can get the id of the anime
>>> kitsupy.get_info('anime', 3919) # Taking the id from the above dictionary
{'createdAt': '2013-02-20T17:00:18.998Z', 'updatedAt': '2021-06-10T06:00:15.132Z', 'slug': 'bakemonogatari', 'synopsis': '#long description', 'coverImageTopOffset': 20, 'titles': {'en': 'Bakemonogatari', 'en_jp': 'Bakemonogatari', 'ja_jp': '化物語'}, 'canonicalTitle': 'Bakemonogatari', 'abbreviatedTitles': ['Ghostory']}
>>> # Note that a lot more data is returned in the dictionary, but for the sake of keeping it simple, the dictionary has been truncated here
```
### Docs
The documentation can be found [here](https://github.com/MetaStag/kitsupy/wiki)
### License
This project can been licensed under the [MIT](https://github.com/MetaStag/kitsupy/blob/main/LICENSE) license.