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.5.2.tar.gz (10.7 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.5.2-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: novelai-api-0.5.2.tar.gz
  • Upload date:
  • Size: 10.7 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.5.2.tar.gz
Algorithm Hash digest
SHA256 1ac158eb223b0d399539a27693a41de79e21ef22d7afa8e1ddf8fc2c29a1ccd8
MD5 2dccf34a8dd39e2c823f181063ce1fd4
BLAKE2b-256 e342e94cf5b9c7dae0cddbb48dcb6b90d9371d793b95c38e396b7a259f6f121a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: novelai_api-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 12.9 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.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bc48cfdb6bad058b6a1b5c0eb2b484ed5d23c077fc59ba1055ff4cbfd08d8cd2
MD5 c05cad811ef12881b162d7d4f34e5c89
BLAKE2b-256 64a0a06319f5c7d9efbdce7d42051afcf51119e19ed4e93607fee74cbad8d88a

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