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

Uploaded Python 3

File details

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

File metadata

  • Download URL: novelai-api-0.6.tar.gz
  • Upload date:
  • Size: 12.4 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.tar.gz
Algorithm Hash digest
SHA256 622e399f755370450b215bb3b24c26a8c52ab319a1467a35c1cb144f92f1bf1a
MD5 cd0f0b5083fe88614571ed0c21c8292f
BLAKE2b-256 4327642caebff3dca1bffb1f7d599bd83566066831efb8725f14fed767d22f4a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: novelai_api-0.6-py3-none-any.whl
  • Upload date:
  • Size: 15.1 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-py3-none-any.whl
Algorithm Hash digest
SHA256 8449c41fd89d7ed43deb53c86fdc45cce7a5629ec9816c76f9ebdc4a31e9734d
MD5 45c41fffa6444c35688630bf14723fce
BLAKE2b-256 0a627b793a8a8828698e12e4905a83e503b711e05aabb22246d0712d65861589

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