Nomad CBEC
Project description
nomad-cbec-id-cli
This is the API descriptor for the Nomad CBEC, responsible for CBEC customer ID check.
Developed by Samarkand Global <https://samarkand.global>
_
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.5.0
- Package version: 1.5.1
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python >= 3.6
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import nomad_cbec_id_cli
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import nomad_cbec_id_cli
Getting Started
Please follow the installation procedure and then run the following:
import time
import nomad_cbec_id_cli
from pprint import pprint
from nomad_cbec_id_cli.api import health_api
# Defining the host is optional and defaults to https://nomad.samarkand-global.cn/cbec
# See configuration.py for a list of all supported configuration parameters.
configuration = nomad_cbec_id_cli.Configuration(
host = "https://nomad.samarkand-global.cn/cbec"
)
# Enter a context with an instance of the API client
with nomad_cbec_id_cli.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = health_api.HealthApi(api_client)
try:
# health
api_response = api_instance.get_health()
pprint(api_response)
except nomad_cbec_id_cli.ApiException as e:
print("Exception when calling HealthApi->get_health: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://nomad.samarkand-global.cn/cbec
Class | Method | HTTP request | Description |
---|---|---|---|
HealthApi | get_health | GET /health | health |
HealthApi | get_metrics | GET /metrics | metrics |
UserApi | id_check | GET /id | idCheck |
Documentation For Models
Documentation For Authorization
ca_key
- Type: API key
- API key parameter name: Authorization
- Location: URL query string
Author
Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in nomad_cbec_id_cli.apis and nomad_cbec_id_cli.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from nomad_cbec_id_cli.api.default_api import DefaultApi
from nomad_cbec_id_cli.model.pet import Pet
Solution 1: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
import nomad_cbec_id_cli
from nomad_cbec_id_cli.apis import *
from nomad_cbec_id_cli.models import *
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
File details
Details for the file nomad-cbec-id-cli-1.5.1.tar.gz
.
File metadata
- Download URL: nomad-cbec-id-cli-1.5.1.tar.gz
- Upload date:
- Size: 38.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.0.1 pkginfo/1.5.0.1 requests/2.26.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5860c4ee7accd50e26fcfa6099d1cdf3c5e4f76aaf6a5f23ef7c2d5ebd6cb1c9 |
|
MD5 | fff9fa06ee6c8dfb2e7f1df121a62ec6 |
|
BLAKE2b-256 | 467ba77b00187b87851bde604248010d56906d7aaaa27276643440ce09a399ce |