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

Uploaded Python 3

File details

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

File metadata

  • Download URL: novelai-api-0.7.tar.gz
  • Upload date:
  • Size: 23.9 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.7.tar.gz
Algorithm Hash digest
SHA256 aca479785a1e5efda1142cc76b74aca4883768c563209a5d344d113b750bf450
MD5 fc903576d31ea5f7e8712338619a32c6
BLAKE2b-256 aeec0d9dfc33f9e5cb87c48765b04155879b00d402146ce34ad8933039970f4c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: novelai_api-0.7-py3-none-any.whl
  • Upload date:
  • Size: 37.6 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f73c4ea754b3256518973a79f246c64ab7dd0a99393cc7c430e431c91d81d805
MD5 021a1f3bbe804d5e021b1870c64e2921
BLAKE2b-256 cfd33d5e994f39eb2ba02aefb3974a45905be5d414f5a9c08bf14eb8b9bdeaa8

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