-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[MISC] Bump version - minor: 0.11.6 -> 0.12.0
- Loading branch information
Showing
2 changed files
with
61 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,60 @@ | ||
| # 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. | ||
|
|
||
| [TODO]: # (Add Quality Checking workflows and badges) | ||
|
|
||
| | Category | Badges | | ||
| |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | Pypi | [](https://pypi.org/project/novelai-api) [](https://pypi.org/project/novelai-api) [](https://pypi.org/project/novelai-api/) [](https://pypi.org/project/novelai-api/) | | ||
| | Quality checking | [](https://github.com/Aedial/novelai-api/actions/workflows/python-package.yml) [](https://github.com/Aedial/novelai-api/actions/workflows/codeql-analysis.yml) [](https://github.com/PyCQA/pylint) [](https://github.com/PyCQA/bandit) [](https://github.com/psf/black) | | ||
| | Stats | [](https://github.com/Aedial/novelai-api/search?l=python)     | | ||
| | Activity |    | | ||
|
|
||
|
|
||
| # Usage | ||
| Download via [pip](https://pypi.org/project/novelai-api): | ||
| ``` | ||
| pip install novelai-api | ||
| ``` | ||
|
|
||
| A full list of examples is available in the [example](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](novelai_api) directory. The [nox](https://pypi.org/project/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](tests/api) | ||
|
|
||
| ## Testing against the mocked API | ||
| | :warning: WIP, does not work yet :warning: | | ||
| |--------------------------------------------| | ||
|
|
||
| [Mock](tests/mock) | ||
|
|
||
| ## Docs | ||
| To build the docs, run | ||
| ``` | ||
| nox -s build-docs | ||
| ``` | ||
| The docs will be locally viewable at docs/build/html/index.html | ||
| # 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. | ||
|
|
||
| [TODO]: # (Add Quality Checking workflows and badges) | ||
|
|
||
| | Category | Badges | | ||
| |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | Pypi | [](https://pypi.org/project/novelai-api) [](https://pypi.org/project/novelai-api) [](https://pypi.org/project/novelai-api/) [](https://pypi.org/project/novelai-api/) | | ||
| | Quality checking | [](https://github.com/Aedial/novelai-api/actions/workflows/python-package.yml) [](https://github.com/Aedial/novelai-api/actions/workflows/codeql-analysis.yml) [](https://github.com/PyCQA/pylint) [](https://github.com/PyCQA/bandit) [](https://github.com/psf/black) | | ||
| | Stats | [](https://github.com/Aedial/novelai-api/search?l=python)     | | ||
| | Activity |    | | ||
|
|
||
|
|
||
| # Usage | ||
| Download via [pip](https://pypi.org/project/novelai-api): | ||
| ``` | ||
| pip install novelai-api | ||
| ``` | ||
|
|
||
| A full list of examples is available in the [example](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](novelai_api) directory. The [nox](https://pypi.org/project/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](tests/api) | ||
|
|
||
| ## Testing against the mocked API | ||
| | :warning: WIP, does not work yet :warning: | | ||
| |--------------------------------------------| | ||
|
|
||
| [Mock](tests/mock) | ||
|
|
||
| ## Docs | ||
| To build the docs, run | ||
| ``` | ||
| nox -s build-docs | ||
| ``` | ||
| The docs will be locally viewable at docs/build/html/index.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| [tool.poetry] | ||
| name = "novelai-api" | ||
| version = "0.11.6" | ||
| version = "0.12.0" | ||
| description = "Python API for the NovelAI REST API" | ||
| license = "MIT" | ||
| authors = ["Aedial <[email protected]>"] | ||
|
|
||