summaryrefslogtreecommitdiff
path: root/python-zevit-aih-sdk.spec
blob: 84461ae41cff1bdad92577e68e15a0cfbecce440 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
%global _empty_manifest_terminate_build 0
Name:		python-ZEVIT-AIH-SDK
Version:	0.5.13
Release:	1
Summary:	Python SDK to connect with ZEVIT Asset Integrity Hub
License:	MIT License
URL:		https://pypi.org/project/ZEVIT-AIH-SDK/
Source0:	https://mirrors.aliyun.com/pypi/web/packages/27/e4/5855cc2e547aa4cd856e756b6351506b95a0bfe70760564820e7e292436d/ZEVIT_AIH_SDK-0.5.13.tar.gz
BuildArch:	noarch

Requires:	python3-numpyencoder
Requires:	python3-pandas
Requires:	python3-numpy
Requires:	python3-requests
Requires:	python3-requests-oauthlib
Requires:	python3-oauthlib
Requires:	python3-pickleshare
Requires:	python3-Pillow

%description
# 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
1.	Install by: pip install AIH_SDK
2.	Initialize AIHClient by: AIH_SDK.AIHClient.AIHClient(environment_to_connect_to, client_id, client_secret, Location)
3.	Get objects from APIs. Example of getting a main system: from AIH_SDK.Assets import MainSystem; mainsystem = MainSystem().get(guid)
4.	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. 




%package -n python3-ZEVIT-AIH-SDK
Summary:	Python SDK to connect with ZEVIT Asset Integrity Hub
Provides:	python-ZEVIT-AIH-SDK
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-ZEVIT-AIH-SDK
# 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
1.	Install by: pip install AIH_SDK
2.	Initialize AIHClient by: AIH_SDK.AIHClient.AIHClient(environment_to_connect_to, client_id, client_secret, Location)
3.	Get objects from APIs. Example of getting a main system: from AIH_SDK.Assets import MainSystem; mainsystem = MainSystem().get(guid)
4.	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. 




%package help
Summary:	Development documents and examples for ZEVIT-AIH-SDK
Provides:	python3-ZEVIT-AIH-SDK-doc
%description help
# 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
1.	Install by: pip install AIH_SDK
2.	Initialize AIHClient by: AIH_SDK.AIHClient.AIHClient(environment_to_connect_to, client_id, client_secret, Location)
3.	Get objects from APIs. Example of getting a main system: from AIH_SDK.Assets import MainSystem; mainsystem = MainSystem().get(guid)
4.	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. 




%prep
%autosetup -n ZEVIT_AIH_SDK-0.5.13

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-ZEVIT-AIH-SDK -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 0.5.13-1
- Package Spec generated