novelai-api 0.12.0

Python API for the NovelAI REST API

novelai-api

Python API for the NovelAI REST API

This module is intended to be used by developers as a helper for using NovelAI's REST API.

Category	Badges
Pypi
Quality checking
Stats
Activity

Usage

Download via pip:

pip install novelai-api

A full list of examples is available in the example directory

The API works through the NovelAIAPI object. It is split in 2 groups: NovelAIAPI.low_level and NovelAIAPI.high_level

low_level

The low level interface is a strict implementation of the official API (https://api.novelai.net/docs). It only checks for input types via assert, and output schema if NovelAIAPI.low_level.is_schema_validation_enabled is True

high_level

The high level interface builds on the low level one for easier handling of complex settings. It handles many tasks from the frontend

Development

All relevant objects are in the novelai_api directory. The nox package is required (pip install nox).

Contributing

You can contribute features and enhancements through PR. Any PR should pass the tests and the pre-commits before submission. The pre-commit hook can be installed via

nox -s pre-commit

Testing against the API

API

Testing against the mocked API

:warning: WIP, does not work yet :warning:

Mock

Docs

To build the docs, run

nox -s build-docs

The docs will be locally viewable at docs/build/html/index.html