Python SDK Documentation
This python package allows ease of access to calls to the BoonLogic Nano API.
- Website: boonlogic.com
- Documentation: Boon Docs Main Page
- Clustering: [Clustering with the expert-python-sdk]({{ site.baseurl}}/docs/Tutorial_The_General_Pipeline.md)
- Autotuning: [Autotuning with the expert-python-sdk]({{ site.baseurl}}/docs/How_To_Autotune_Data.md)
- Results: [Results after clustering]({{ site.baseurl}}/docs/How_To_Generate_Cluster_Results.md)
- SDK Functional Breakdown: [expert-python-sdk classes and methods]({{ site.baseurl}}/docs/boonnano/index.html)(docs/boonnano/index.html)
Installation
The BoonNano SDK is a Python3 project and can be installed via pip.
pip install boonnano
License setup
Note: A license must be obtained from Boon Logic to use the BoonNano Python SDK
The license should be placed in a file named ~/.BoonLogic.license
{
"default": {
"api-key": "API-KEY",
"server": "WEB ADDRESS",
"api-tenant": "API-TENANT"
}
}
The API-KEY, WEB ADDRESS, and API-TENANT will be unique to your obtained license.
The .BoonLogic.license file will be consulted by the BoonNano Python SDK to successfully find and authenticate with your designated server.
Connectivity Test
The following Python script provides a basic proof-of-connectivity:
connect-example.py
import boonnano as bn
import json
import sys
#
# connectivity example for boonnano
#
try:
# create client handle
nano = bn.ExpertClient.from_license_file(license_id='default')
# open/attach to nano
instance_id = 'my-instance'
nano.open_nano(instance_id)
# retrieve server version
response = nano.get_version()
print(json.dumps(response, indent=4))
# close/detach the nano instance
nano.close_nano(instance_id)
except bn.BoonException as be:
print(be.message)
sys.exit(1)
Running the connect-test.py script should yield something like:
% python connect-example.py
{
"release": "dev",
"api-version": "/expert/v3",
"nano-secure": "3c40f1d6",
"builder": "f5db0682",
"expert-api": "f6643822",
"expert-common": "c0575a50",
"swagger-ui": "914af396"
}
2 maintainers
Release files for boonnano 3.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| boonnano-3.2.0.tar.gz | 16.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| boonnano-3.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.4 kB
Release files / boonnano-3.2.0.tar.gz
| Download URL | boonnano-3.2.0.tar.gz |
|---|---|
| Size | 16.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
153d819b6ba4fabe19137f7b9ab26bba5127f295eafb0a57b27aac8a87921251
|
|
BLAKE2b-256 checksum How to use checksums |
249ec7de49f7b17e217e68768d1ed87b893adf69c1b614cba4340b6507b864e2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / boonnano-3.2.0-py3-none-any.whl
| Download URL | boonnano-3.2.0-py3-none-any.whl |
|---|---|
| Size | 10.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1e9f9b8250a167671b1bad96d9c6b11630cfc94e6107af3e13473f86934ddb4f
|
|
BLAKE2b-256 checksum How to use checksums |
25f118116fb3c273c01e85718c972c40f9bb7c3537d17d5a32da79fa22ac70fa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
