Git Product home page Git Product logo

kitsune's Introduction

kitsune

This project is a work in progress, currently in a pre-alpha release.

Kitsune is a simple and extensible Python API wrapper for the Kitsu Anime/Manga API. I only intend to cover the following endpoints:

  • Anime
  • Manga
  • Categories
  • Characters

Kitsune will be for getting information directly related manga and anime. The "social media" (so to speak) portion of Kistu will be ignored as much as possible, only being referenced when absoultely necessary. Objects that link to Kistu users, posts, etc. will be ommited if possible.

Overview

Installation

Manager Command
pip pip install kitsune.py
poetry python -m poetry add kitsune.py
easy_install easy_install kitsune.py

Usage

Again, this is a work in progress, consider these code snippets implementation notes.

Without authentication:

from kitsune import Client

client = Client.new()

anime = client.search_anime("Coboy Bebop")
manga = client.search_manga("Rent A Girlfriend")

Using user authentication:

from kitsune import Client

client = Client.authenticate(username="user123", password="wordpass")

collection = client.get_category("Comedy")

Testing and Contributing

  1. Clone the repository with git:

    • git clone https://github.com/frissyn/kitsune.git
    • cd kitsune
  2. Make your changes

  3. Run tests from within the bin script:

    • bash bin/test.sh
    • Make sure all tests pass!

Other Notes

This repository uses labeled commits that follow my prefix guide. When contributing, please adhere to that guide: github.com/frissyn/commit-prefixes

kitsune's People

Contributors

frissyn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.