Introduction
This project makes it possible to easily interact with the objects in ZEVIT's Asset Integrity Hub.
Project is structured as follows:
AIH_SDK
├── AIHClient
├── Assets
│ ├── Equipment
│ ├── MainSystem
│ └── Plant
├── DataProcessing
│ ├── Job
│ ├── JobConfiguration
│ └── JobDefinition
├── Files
│ ├── DataType
│ └── File
├── Designations
│ ├── Design
│ ├── Schema
│ └── Structure
├── Risks
│ ├── Mitigation
│ ├── Risk
│ └── RiskAssessmentResult
├── Monitors
│ ├── Monitor
│ ├── Model
│ └── ModelDefinition
├── Maintenance
│ ├── Deviation
│ ├── WorkItem
│ └── Activity
│ ├── WorkTemplate
│ └── ActivityTemplate
│ └── Input
│ └── Media
│ └── MediaReference
├── Signals
│ ├── Channel
│ └── Signal
├── Workitems
│ ├── Annotation
│ ├── Assessment
│ ├── AssignedElement
│ ├── Failure
│ ├── Media
│ ├── MediaReference
│ ├── PanoramaImage
│ ├── PanoramicTour
│ └── WorkorderItem
Getting Started
- Install by: pip install AIH_SDK
- Initialize AIHClient by: AIH_SDK.AIHClient.AIHClient(environment_to_connect_to, client_id, client_secret, Location)
- Get objects from APIs. Example of getting a main system: from AIH_SDK.Assets import MainSystem; mainsystem = MainSystem().get(guid)
- Objects support CRUD operation in form of post, get, put, and delete.
Object design
Objects store the information fetched from the APIs in the self.value of the object
self.value can either be a dict containing one instance or be a list containing multiple dicts, representing multiple objects.
All objects contain the following methods:
- get()
- put()
- post()
- delete()
- copy()
- get_value()
- set_value()
- update_values()
- to_dataframe()
- get_keys()
- filter()
- from_dataframe()
- from_dict()
- from_list()
- join()
Methods that modifies the object operate inplace, but also return the object itself to allow chaining of methods.
API version
All AIH api's are versioned. If not value is specified the latest spi version is selected by default. To specify the version of an api add the argument api_version when creating the instance of you object for example: MainSystem(api_version='1.4').get(). Please see the documentation to see active versions.
PropertyDefinitions
Many Modules in AIH uses property definitions to customize data models to specific usecases. The python sdk supports assigning property values to an object (like a mainsystem) but also creating new property definitions with associated categories and classifications.
1 maintainer
Release files for ZEVIT-AIH-SDK 0.5.13
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ZEVIT_AIH_SDK-0.5.13.tar.gz | 23.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ZEVIT_AIH_SDK-0.5.13-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 74.4 kB
Release files / ZEVIT_AIH_SDK-0.5.13.tar.gz
| Download URL | ZEVIT_AIH_SDK-0.5.13.tar.gz |
|---|---|
| Size | 23.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ad1fba43c59d1302c03a58e7555aa14c7d14ba1d9d6c6c860315d129cff62466
|
|
BLAKE2b-256 checksum How to use checksums |
27e45855cc2e547aa4cd856e756b6351506b95a0bfe70760564820e7e292436d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.8.16
|
Release files / ZEVIT_AIH_SDK-0.5.13-py3-none-any.whl
| Download URL | ZEVIT_AIH_SDK-0.5.13-py3-none-any.whl |
|---|---|
| Size | 50.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9f323f7ad3baf8a928476dd93e20e34217d09757ce487a1b821c789cb24a7657
|
|
BLAKE2b-256 checksum How to use checksums |
cf2ae31189f195806a0c21be4b0082d7db197121c073e4a5a47975dbc032759f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.8.16
|
