| Name | nbsapi-verify JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | Verify an nbsinfra API implementation |
| upload_time | 2025-03-11 16:28:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License |
| keywords |
nbsapi
nbsinfra
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NbSAPI Verification Tool
`nbsapi_verify` is a standalone tool designed to verify that your API implementation conforms to the <https://nbsapi.org> OpenAPI specification, currently at Version 1.0.
## Installation and Usage
### Installation (temporary)
#### Using [pipx](https://pipx.pypa.io)
`pipx nbsapi_verify --help`
#### Using [uvx](https://docs.astral.sh/uv/guides/tools/)
`uvx nbsapi_verify --help`
### Installation (permanent, on `$PATH`)
If you would prefer the tool to be **installed** on your `PATH` you can run:
`pipx install nbsapi_verify` or `uv tool install nbsapi_verify`. You can then run `nbsapi_verify` without prefixes.
### Installation as a _package_
You can also install the package using your preferred Python package manager:
#### Using pip
```shell
pip install nbsapi_verify
```
#### Using uv
```shell
uv add nbsapi_verify
```
#### Using poetry
```shell
poetry add nbsapi_verify
```
After installation, you can run the tool using the installed script:
```shell
nbsapi_verify --help
```
### Usage
`nbsapi_verify` requires a small amount of configuration:
1. First, generate a verification config. This requires you to specify:
- the host the API is running on
- a valid username
- the password for that username
- the ID of that user
- a path for the verification config to be stored (optional: it defaults to the current working directory)
- the test type to be run: `all`, `auth`, `user`: the `auth` tests will exercise the write API functions, while the `user` tests will exercise the read API functions (defaults to `all`).
In order to test your API while locally developing, that command might look like:
```shell
nbsinfra_verify --generate \
--host http://localhost:8000 \
--test-type all
--username testuser \
--password testpass \
--testid 1 \
--config-dir ~
```
If the command completes sucessfully, you can run the verification tool:
```shell
nbsinfra_verify --config-dir ~
```
When all tests pass, your API implementation is conformant to the `NbsAPI` specification!
## Help
`nbsinfra_verify --help`
Raw data
{
"_id": null,
"home_page": null,
"name": "nbsapi-verify",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "nbsapi, nbsinfra",
"author": null,
"author_email": "Stephan H\u00fcgel <urschrei@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/30/f3/9dce7912063c6580187df92bafcb05f1fc2d16882c9cf96aa81ec23c63ff/nbsapi_verify-0.1.5.tar.gz",
"platform": null,
"description": "# NbSAPI Verification Tool\n\n`nbsapi_verify` is a standalone tool designed to verify that your API implementation conforms to the <https://nbsapi.org> OpenAPI specification, currently at Version 1.0.\n\n## Installation and Usage\n### Installation (temporary)\n#### Using [pipx](https://pipx.pypa.io)\n`pipx nbsapi_verify --help`\n\n#### Using [uvx](https://docs.astral.sh/uv/guides/tools/)\n`uvx nbsapi_verify --help`\n\n### Installation (permanent, on `$PATH`)\nIf you would prefer the tool to be **installed** on your `PATH` you can run:\n\n`pipx install nbsapi_verify` or `uv tool install nbsapi_verify`. You can then run `nbsapi_verify` without prefixes.\n\n### Installation as a _package_\nYou can also install the package using your preferred Python package manager:\n\n#### Using pip\n```shell\npip install nbsapi_verify\n```\n\n#### Using uv\n```shell\nuv add nbsapi_verify\n```\n\n#### Using poetry\n```shell\npoetry add nbsapi_verify\n```\n\nAfter installation, you can run the tool using the installed script:\n```shell\nnbsapi_verify --help\n```\n\n### Usage\n`nbsapi_verify` requires a small amount of configuration:\n\n1. First, generate a verification config. This requires you to specify:\n - the host the API is running on\n - a valid username\n - the password for that username\n - the ID of that user\n - a path for the verification config to be stored (optional: it defaults to the current working directory)\n - the test type to be run: `all`, `auth`, `user`: the `auth` tests will exercise the write API functions, while the `user` tests will exercise the read API functions (defaults to `all`).\n\nIn order to test your API while locally developing, that command might look like:\n\n```shell\nnbsinfra_verify --generate \\\n --host http://localhost:8000 \\\n --test-type all\n --username testuser \\\n --password testpass \\\n --testid 1 \\\n --config-dir ~\n```\n\nIf the command completes sucessfully, you can run the verification tool:\n\n```shell\nnbsinfra_verify --config-dir ~\n```\n\nWhen all tests pass, your API implementation is conformant to the `NbsAPI` specification!\n\n## Help\n`nbsinfra_verify --help`\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Verify an nbsinfra API implementation",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://nbsapi.org",
"Repository": "https://github.com/nbsapi/nbsapi_verify",
"Tracker": "https://github.com/nbsapi/nbsapi_verify/issues"
},
"split_keywords": [
"nbsapi",
" nbsinfra"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aa22230e0dd421f30bb699704a5cd03bc2804548f3320cf9d46dc5caef435df3",
"md5": "9b9fb4abc66aee0c3326322cb4ea39c1",
"sha256": "71a11c45adec19971362d4124eb09860b8e191bf555648ecc3c77626d287c243"
},
"downloads": -1,
"filename": "nbsapi_verify-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b9fb4abc66aee0c3326322cb4ea39c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13876,
"upload_time": "2025-03-11T16:28:16",
"upload_time_iso_8601": "2025-03-11T16:28:16.672548Z",
"url": "https://files.pythonhosted.org/packages/aa/22/230e0dd421f30bb699704a5cd03bc2804548f3320cf9d46dc5caef435df3/nbsapi_verify-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "30f39dce7912063c6580187df92bafcb05f1fc2d16882c9cf96aa81ec23c63ff",
"md5": "df80df3b900cd637af27ccef8545da0d",
"sha256": "de23d3ab0e2b3162e128de44a382dcc3599e9691bdd7e2718faa6731f43d7d67"
},
"downloads": -1,
"filename": "nbsapi_verify-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "df80df3b900cd637af27ccef8545da0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 44656,
"upload_time": "2025-03-11T16:28:18",
"upload_time_iso_8601": "2025-03-11T16:28:18.450265Z",
"url": "https://files.pythonhosted.org/packages/30/f3/9dce7912063c6580187df92bafcb05f1fc2d16882c9cf96aa81ec23c63ff/nbsapi_verify-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-11 16:28:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nbsapi",
"github_project": "nbsapi_verify",
"github_not_found": true,
"lcname": "nbsapi-verify"
}
