Python library to communicate with Wood NEXUS IC tool
Project description
pynexusic
pynexusic
is a package that allows communication with Wood NEXUS IC tool
Prerequisites
- NEXUS IC V6.6
- IC-Web V6.6
NEXUS IC Documentation
The NEXUS IC REST API documentation can be found in the below link:
https://docs.nexusic.com/6.6/ic-web.rest.v2.html
A specific NEXUS IC version can be specified in the above link by changing 6.6 to the desired NEXUS IC version
Python library installation
pip install pynexusic
Examples
- Example 1: Get system version
-
Import
NEXUSIC_RESTAPI
from pynexusic import NEXUSIC_RESTAPI as api
-
Initialize
NEXUSIC_REST
classNX_REST = api.NEXUSIC_REST(baseURI, api_key=APIKey)
where APIKey is the user's API Key provided by the system administrator
-
Execute required function
result, result_status_code = NX_REST.getVersion()
Output:
result = {'version': 'x.x.xxxxx.x', 'schema': 'x.xxx'} result_code = 200
-
- Example 2: Run reports and get python object response
-
Import
NEXUSIC_RESTAPI
from pynexusic import NEXUSIC_RESTAPI as api
-
Initialize
NEXUSIC_REST
classNX_REST = api.NEXUSIC_REST(baseURI, api_key=APIKey)
where APIKey is the user's API Key provided by the system administrator
-
Execute required report
result, result_status_code = NX_REST.getDashboard(report_name)
where report_name is the name of the report to be executed in NEXUS IC
Output:
result = {'name': 'xxxxxxxxxxx', 'elements': [{'type': 'section', 'data': {}}, {'type': 'paragraph', 'data': {'text': [{'value': 'xxxxxx'}]}} ] } result_code = 200
The values of the elements key will contain the data configured in the NEXUS IC report template
-
Change history
(V2.0.5) Changes:
- NEXUSIC_RESTAPI:
- Improved disconnection error handler
getAssetChildren
function: Added the ability to search at a specific level- Added
getAssetTypesID
function - Added
getTableDBNames
function
(V2.0.4) Changes:
- NEXUSIC_RESTAPI:
- Added
getAssetLocationByName
function - Added
getAssetLocationByID
function - Added
getAssetChildren
function
- Added
(V2.0.3) Changes:
- NEXUSIC_RESTAPI:
- Added the ability to authenticate using two modes (APIKEY and BASIC)
- APIKEY: Requires an API Key to authenticate
- BASIC: Requires username and password
- Added the ability to authenticate using two modes (APIKEY and BASIC)
(V2.0.2) Changes:
- NEXUSIC_RESTAPI:
- Added the ability to bypass SSL verification
(V2.0.1) Changes:
- Initial deployment in pypi.org
License
This project is licensed under the MIT license.
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
Hashes for pynexusic-2.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0ba3bb520d7c597b8d01dad06882d51bd1296f001acc3e810557af69bce776e |
|
MD5 | 380217a65c3480ecafa77e2b91a2c1a6 |
|
BLAKE2b-256 | 359bc4eb55bec55a425273054e2933d1d8fb6a412813b6ad66aa2b0bc83e0c0e |