kavitapy 0.1.0a1

A python wrapper for the Kavita API

A python wrapper for the Kavita API

Table of Contents

• Installation
• Usage
  • Plugin authentication
  • HTTP Status Code
  • /api/Reader endpoints
  • /api/Library endpoints
  • /api/Series endpoints
• Versioning

Installation

Use pip in your terminal of choice.
$ python -m pip install kavitapy

This library requires Python 3. Testing is done on Python 3.10

Usage

Import the package using

from kavitapy import api

or

import kavitapy

Plugin authentication

Plugin authentication is done simply by initialising the api-object.

kavita = kavitapy.api("url","api key")

You can view the full response for your authentication request.

kavita.raw_plugin_auth

Your token can also be accessed.

kavita.token

Replace url with your server address. Make sure to include http:// or https://.
Replace api key with your user's API key. You can find it under the 3rd Party Clients tab in your user settings in the webinterface.

HTTP Status Code

Executing any method updates the status code returned.

kavita.status_code

/api/Reader endpoints

Return information about a single chapter

kavita.reader_chapter_info(Chapter(Int))

Mark all series in the list as read or unread

kavita.reader_mark_multiple_series("operation",Series(List))

operation can be either read or unread.

Mark all series in the list as read

kavita.reader_mark_multiple_series_read(Series(List))

Mark all series in the list as unread

kavita.reader_mark_multiple_series_unread(Series(List))

Return progress for a chapter

kavita.reader_get_progress(Chapter(Int))

Set reading progress on chapter

kavita.reader_progress(Series(Int),Volume(Int),Chapter(Int),Page(Int),Bookscroll(String))

Return the current progress on a series

kavita.reader_continue_point(Serie(Int))

/api/Library endpoints

/api/Series endpoints

Versioning

This project aims to follow the PEP 440 specification versioning.