Code Monkey home page Code Monkey logo

komgapy's Introduction

KomgaPy

KomgaPy is an incomplete Komga API wrapper for python. KomgaPy is still under development and has not been thoroughly tested.

Currently KomgaPy has the ability to

  • Get data from series, books, collections, readlists, and libraries
  • Search for series, books, collections, and readlists
  • Post new collection and readlists
  • Overwrite current collections and readlists
  • Edit / update metadata for series and books
  • Update poster art from file path
  • Scan, analyze, and refresh libraries
  • Get thumbnail images for series, books, collections, and readlists
  • Get files for series, books, and readlists
  • Ability to match books from .cbl
    • can match cbl from path or url
  • Delete readlists and collections from library

To Do

  • Refactor methods with better class structure and naming
    • all methods have changed
  • Add more endpoints
  • First Alpha Release

Installation

  • Currently KomgaPy has to be installed from github
    • Eventually will be added to PyPI
pip install git+https://github.com/Lerch4/KomgaPy

Usage

  • KomgaPy is used by creating an instance of a KomgaSession and utilizing its methods to access the Komga API. KomgaSession takes the host URL address of the Komga server and a tuple of the username and password of your account.
from komgapy import KomgaSession
session = KomgaSession(komga_url, (user, password))

series = session.series.get(series_name='Batman (2011)')
series.print_data(indent = 2)

See docs for further usage examples.

komgapy's People

Contributors

lerch4 avatar

Watchers

 avatar  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.