Metadata-Version: 2.1
Name: boonnano
Version: 3.1.4
Summary: A SDK package for utilizing the BoonLogic nano API
Home-page: https://github.com/boonlogic/Python_API
Author: BoonLogic
Author-email: elise@boonlogic.com
License: MIT
Description: # Python SDK Documentation
        This python package allows ease of access to calls to the BoonLogic Nano API.
        
        - __Website__: [boonlogic.com](https://boonlogic.com)
        - __Documentation__: [Boon Docs Main Page](https://docs.boonlogic.com)
        - __Clustering__: [Clustering with the expert-python-sdk](docs/Tutorial_The_General_Pipeline.md)
        - __Autotuning__: [Autotuning with the expert-python-sdk](docs/How_To_Autotune_Data.md)
        - __Results__: [Results after clustering](docs/How_To_Generate_Cluster_Results.md)
        - __SDK Functional Breakdown__: [expert-python-sdk classes and methods](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
        
        ```json
        {
          "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**
        
        ```python
        import boonnano as bn
        import json
        import sys
        
        # create new nano handle
        try:
            nano = bn.NanoHandle('default')
        except bn.BoonException as be:
            print(be)
            sys.exit(1)
        
        # open/attach to nano
        success, response = nano.open_nano('my-instance')
        if not success:
            print("open_nano failed: {}".format(response))
            sys.exit(1)
        
        # fetch the version information for this nano instance
        success, response = nano.get_version()
        if not success:
            print("get_version failed: {}".format(response))
            sys.exit(1)
        print(json.dumps(response, indent=4))
        
        # close/detach the nano instance
        success, response = nano.close_nano()
        if not success:
            print("close_nano failed: {}".format(response))
            sys.exit(1)
        
        ```
        
        Running the connect-test.py script should yield something like:
        
        ```sh
        % python connect-example.py
        {
            "release": "dev",
            "api-version": "/expert/v3",
            "nano-secure": "3c40f1d6",
            "builder": "f5db0682",
            "expert-api": "f6643822",
            "expert-common": "c0575a50",
            "swagger-ui": "914af396"
        }
        ```
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
