Skip to main content

A Python library for LANraragi API.

Project description

lanraragi-api

A Python library for LANraragi API.

Many thanks to the author of this wonderful manga server.

Quick start

Install this package:

pip install lanraragi_api

Get metadata of a random archive:

See demo.py

from lanraragi_api import LANraragiAPI
from lanraragi_api.base.archive import ArchiveMetadata

apikey = "your-key"
server = "http://127.0.0.1:3000"
api = LANraragiAPI(server, key=apikey)

archives: list[ArchiveMetadata] = api.search.get_random_archives()
print(archives[0])

How to use?

All the APIs in the lanraragi_api.base package are from the official LANraragi document, which you will be using in most times.

Functions in the lanraragi_api.enhanced package are built on the base APIs, offering useful functionalities.

  • server_side.py contains server-side functions. The code is the same to that of LANraragi, only translated from Perl to Python.
  • script.py contains functions for operation and management.

Release versions

Every release of lanraragi-api is made only for the corresponding release of LANraragi. So you should choose the correct lanraragi-api version based on the server version.

LANraragi lanraragi-api
v.0.9.0 0.9.0.0, 0.9.0.1, ... , 0.9.0.x
v.0.9.40 0.9.40.0, 0.9.40.1, ... , 0.9.40.y

In order to make it simple, the first three version numbers are always the same, while the last version number of lanraragi-api serves as patches (just choose the latest one).

Development

Python version: 3.10

Code formatter: default setting of VS Code's Black Formatter extension

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lanraragi_api-0.9.70.0.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lanraragi_api-0.9.70.0-py3-none-any.whl (34.7 kB view details)

Uploaded Python 3

File details

Details for the file lanraragi_api-0.9.70.0.tar.gz.

File metadata

  • Download URL: lanraragi_api-0.9.70.0.tar.gz
  • Upload date:
  • Size: 30.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for lanraragi_api-0.9.70.0.tar.gz
Algorithm Hash digest
SHA256 a83a4784f15ad1c41844d5c877ddb258d158e382d738446eb4c853426949589b
MD5 1218dbefe7f4b7f2f66797c6556cf6b0
BLAKE2b-256 62cef6a8fc50344ed8dc9bc1bed91e2f5779d520ffe256295e7e57e4adbad76b

See more details on using hashes here.

File details

Details for the file lanraragi_api-0.9.70.0-py3-none-any.whl.

File metadata

File hashes

Hashes for lanraragi_api-0.9.70.0-py3-none-any.whl
Algorithm Hash digest
SHA256 224f9872ac873aa6559f71d506ef4e3ab58113c07cd4c69d855466dceb99ec03
MD5 e58395b62865b9705eb82dcb4301929a
BLAKE2b-256 17413197901522583fff885407970bff10f83fe6dedbd83f2d7881587c71c394

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page