IncQuery Server Web API
Project description
incqueryserver-api-python-client
This package offers an easy way to connect to a running IncQuery Server instance.
Connect to a running IncQuery Server
from iqs_api import connect
No authentication
iqs = connect("https://incqueryserver.url.com")
OpenID Connect (OIDC)
token = "token"
iqs = connect(
address="https://incqueryserver.url.com",
auth_header_name="Authorization",
auth_header_value=f"Bearer {token}",
use_auth_header=True
)
Basic Authentication
iqs = connect(
address="https://incqueryserver.url.com",
username="username",
password="password"
)
Issue API calls
GET request example:
response = iqs.server_management.get_server_info()
POST request example:
from iqs_client import models
response = iqs.demo.update_model_compartment_index(
index_compartment=models.IndexCompartment(
model_compartment="model_compartment_uri",
indexes=["index1", "index2"]
)
)
IMPORTANT: It is recommended to provide parameters as keyword arguments (opposed to positional)
Other options
Configure self-signed certificate
from iqs_client import Configuration
custom_config = Configuration()
custom_config.ssl_ca_cert = "path/to/cert.cer"
iqs = connect(
address="https://incqueryserver.url.com",
configuration=custom_config
)
Disable SSL verification
from iqs_client import Configuration
custom_config = Configuration()
custom_config.verify_ssl = False
iqs = connect(
address="https://incqueryserver.url.com",
configuration=custom_config
)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for incqueryserver-api-python-client-0.27.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d48e46e599e4b91ccb6ddde8addb21ff45ef2d4ac7592fbc6198a803f8182c88 |
|
MD5 | c81310a26381ef64fb19e74493086b0e |
|
BLAKE2b-256 | cce2b0dd0a586f46e0ce404799195d9eb2e65cfbe35f49006c4650d7b3763480 |
Close
Hashes for incqueryserver_api_python_client-0.27.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1af6b1a21c64a9655fdb0df78c8bfecf41e554b72fa997747e0e54215e7ce281 |
|
MD5 | b9cd0a2177aefafddf6082cc3b1d5017 |
|
BLAKE2b-256 | a9f96ff311764ac9803a4fdc22bd61e97de06a925c3b359a694ee95de8549d79 |