Skip to main content

Python API for the NovelAI REST API

Project description

novelai-api

Python API for the NovelAI REST API

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

Prerequisites:

For loging in, credentials are needed. They should be placed into /credentials/.txt with depending on the script to execute.

Examples:

The examples are in the example folder. Each example is working and can be used as a test. Each example can be called with python <name>.py.

Tests:

The test suite is WIP and can be called with python tests/test.py [-n <number of iterations>] [--no-login] [--side-effect]. A login will be require unless --no-login is passed --side-effect will allow the class to modify things on the logged account, and can have undesired effects (so use it with caution !).

Module:

The actual module is in the novelai-api folder. Valid imports are : novelai_api.NovelAI_API, novelai_api.NovelAIError, and everything under the novelai_api.utils namespace. This module is asynchronous, and, as such, must be run with asyncio. An example can be found in any file of the example directory. The module is registered as package under Pypi.

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

novelai-api-0.6.1.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

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

novelai_api-0.6.1-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file novelai-api-0.6.1.tar.gz.

File metadata

  • Download URL: novelai-api-0.6.1.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2

File hashes

Hashes for novelai-api-0.6.1.tar.gz
Algorithm Hash digest
SHA256 c42d36dde961ace02ca573e46e60f2ff230983529fac1cd861012d094f69611f
MD5 887f5159bd7520d58d90e3a7a7b00194
BLAKE2b-256 f22c752b211e3c3bcd0a81b90b9c7a7ccf5bf9e0bd8d7ecbb94afbf520194cfc

See more details on using hashes here.

File details

Details for the file novelai_api-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: novelai_api-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2

File hashes

Hashes for novelai_api-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fbfb847f82249d486a20dff5330a8c5133b8e5374c28e264d06617a38c76f4d7
MD5 71e26a26893e7301c4b8d5fd4b5a4859
BLAKE2b-256 c6739da72487134d0111d79dae4767cb3d47addc6af58b61de41b9b376da4b9e

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