pyegeria 0.3.8__py3-none-any.whl → 0.4.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. pyegeria/Xfeedback_manager_omvs.py +238 -0
  2. pyegeria/Xloaded_resources_omvs.py +91 -0
  3. pyegeria/__init__.py +15 -12
  4. pyegeria/_client.py +4 -6
  5. pyegeria/{gov_engine.py → _deprecated_gov_engine.py} +2 -59
  6. pyegeria/_exceptions.py +5 -6
  7. pyegeria/_globals.py +3 -1
  8. pyegeria/asset_catalog_omvs.py +672 -0
  9. pyegeria/automated_curation_omvs.py +627 -359
  10. pyegeria/collection_manager_omvs.py +187 -248
  11. pyegeria/core_guids.py +128 -0
  12. pyegeria/core_omag_server_config.py +1 -5
  13. pyegeria/full_omag_server_config.py +53 -83
  14. pyegeria/glossary_browser_omvs.py +2208 -0
  15. pyegeria/glossary_manager_omvs.py +3002 -0
  16. pyegeria/my_profile_omvs.py +2 -7
  17. pyegeria/platform_services.py +0 -3
  18. pyegeria/project_manager_omvs.py +9 -15
  19. pyegeria/registered_info.py +12 -52
  20. pyegeria/runtime_manager_omvs.py +967 -0
  21. pyegeria/server_operations.py +1 -5
  22. pyegeria/valid_metadata_omvs.py +204 -43
  23. pyegeria-0.4.0.data/scripts/Create_Collection_Sample.py +292 -0
  24. pyegeria-0.4.0.data/scripts/Create_Sustainability_Collection_Sample.py +115 -0
  25. pyegeria-0.4.0.data/scripts/get_guid_info.py +86 -0
  26. pyegeria-0.3.8.data/scripts/view_my_profile.py → pyegeria-0.4.0.data/scripts/get_my_profile.py +8 -34
  27. {pyegeria-0.3.8.data → pyegeria-0.4.0.data}/scripts/get_tech_details.py +1 -37
  28. pyegeria-0.4.0.data/scripts/get_tech_type_elements.py +137 -0
  29. pyegeria-0.4.0.data/scripts/get_tech_type_template.py +137 -0
  30. {pyegeria-0.3.8.data → pyegeria-0.4.0.data}/scripts/list_asset_types.py +3 -25
  31. pyegeria-0.4.0.data/scripts/list_assets.py +138 -0
  32. pyegeria-0.3.8.data/scripts/project_list_viewer.py → pyegeria-0.4.0.data/scripts/list_projects.py +13 -27
  33. pyegeria-0.4.0.data/scripts/list_registered_services.py +135 -0
  34. pyegeria-0.3.8.data/scripts/get_relationship_types.py → pyegeria-0.4.0.data/scripts/list_relationship_types.py +25 -43
  35. pyegeria-0.4.0.data/scripts/list_tech_templates.py +134 -0
  36. pyegeria-0.3.8.data/scripts/find_todos.py → pyegeria-0.4.0.data/scripts/list_todos.py +11 -39
  37. pyegeria-0.4.0.data/scripts/list_valid_metadata_values.py +144 -0
  38. pyegeria-0.4.0.data/scripts/view_asset_graph.py +236 -0
  39. pyegeria-0.3.8.data/scripts/multi-server_status.py → pyegeria-0.4.0.data/scripts/view_coco_status.py +17 -39
  40. pyegeria-0.3.8.data/scripts/collection_viewer.py → pyegeria-0.4.0.data/scripts/view_collection.py +12 -31
  41. pyegeria-0.3.8.data/scripts/engine_action_status.py → pyegeria-0.4.0.data/scripts/view_eng_action_status.py +17 -31
  42. pyegeria-0.3.8.data/scripts/glossary_view.py → pyegeria-0.4.0.data/scripts/view_glossary.py +2 -2
  43. pyegeria-0.3.8.data/scripts/gov_engine_status.py → pyegeria-0.4.0.data/scripts/view_gov_eng_status.py +0 -1
  44. pyegeria-0.3.8.data/scripts/integration_daemon_status.py → pyegeria-0.4.0.data/scripts/view_integ_daemon_status.py +30 -42
  45. pyegeria-0.3.8.data/scripts/my_todos.py → pyegeria-0.4.0.data/scripts/view_my_todos.py +1 -1
  46. pyegeria-0.3.8.data/scripts/open_todos.py → pyegeria-0.4.0.data/scripts/view_open_todos.py +3 -24
  47. pyegeria-0.4.0.data/scripts/view_platform_status.py +123 -0
  48. pyegeria-0.3.8.data/scripts/server_status.py → pyegeria-0.4.0.data/scripts/view_server_status.py +1 -20
  49. {pyegeria-0.3.8.dist-info → pyegeria-0.4.0.dist-info}/METADATA +5 -4
  50. pyegeria-0.4.0.dist-info/RECORD +58 -0
  51. {pyegeria-0.3.8.dist-info → pyegeria-0.4.0.dist-info}/WHEEL +1 -1
  52. pyegeria/glossary_omvs.py +0 -789
  53. pyegeria/loaded_resources_omvs.py +0 -159
  54. pyegeria-0.3.8.dist-info/RECORD +0 -42
  55. /pyegeria/{governance_author.py → action_author_omvs.py} +0 -0
  56. /pyegeria-0.3.8.data/scripts/get_tech_types.py → /pyegeria-0.4.0.data/scripts/list_tech_types.py +0 -0
  57. /pyegeria-0.3.8.data/scripts/server_status_widget.py → /pyegeria-0.4.0.data/scripts/view_server_list.py +0 -0
  58. {pyegeria-0.3.8.dist-info → pyegeria-0.4.0.dist-info}/LICENSE +0 -0
  59. {pyegeria-0.3.8.dist-info → pyegeria-0.4.0.dist-info}/top_level.txt +0 -0
@@ -28,10 +28,6 @@ class ServerOps(Platform):
28
28
  when the user doesn't pass the user_id on a method call.
29
29
  user_pwd: str
30
30
  The password associated with the user_id. Defaults to None
31
- verify_flag: bool
32
- Flag to indicate if SSL Certificates should be verified in the HTTP requests.
33
- Defaults to False.
34
-
35
31
 
36
32
  """
37
33
  def __init__(
@@ -370,7 +366,7 @@ class ServerOps(Platform):
370
366
 
371
367
  def get_integration_connector_status(self, server: str = None) -> None:
372
368
  """ Get the current status of the integration connector. Async version."""
373
- response = self.get_integration_daemon_status(server)
369
+ self.get_integration_daemon_status(server)
374
370
  # todo - finish this? (and do async)
375
371
  pass
376
372
 
@@ -6,20 +6,10 @@ Copyright Contributors to the ODPi Egeria project.
6
6
 
7
7
  """
8
8
  import asyncio
9
- import json
10
- import time
11
9
 
12
10
  # import json
13
11
  from pyegeria._client import Client
14
- from pyegeria._exceptions import (
15
- InvalidParameterException,
16
- )
17
- from pyegeria._globals import enable_ssl_check
18
- from pyegeria._validators import (
19
- validate_guid,
20
- validate_search_string,
21
- )
22
- from pyegeria.utils import body_slimmer
12
+ from pyegeria._globals import enable_ssl_check, max_paging_size
23
13
 
24
14
 
25
15
  class ValidMetadataManager(Client):
@@ -37,9 +27,6 @@ class ValidMetadataManager(Client):
37
27
  when the user doesn't pass the user_id on a method call.
38
28
  user_pwd: str
39
29
  The password associated with the user_id. Defaults to None
40
- verify_flag: bool
41
- Flag to indicate if SSL Certificates should be verified in the HTTP requests.
42
- Defaults to False.
43
30
 
44
31
  """
45
32
 
@@ -53,11 +40,188 @@ class ValidMetadataManager(Client):
53
40
  verify_flag: bool = enable_ssl_check,
54
41
  ):
55
42
  self.command_base: str = f"/api/open-metadata/valid-metadata"
43
+ self.page_size = max_paging_size
56
44
  Client.__init__(self, server_name, platform_url, user_id=user_id, token=token)
57
45
 
46
+ async def _async_setup_valid_metadata_value(self, property_name: str, type_name: str, body: dict,
47
+ server: str = None):
48
+ """ Create or update the valid value for a particular open metadata property name. If the typeName is null,
49
+ this valid value applies to properties of this name from all types. The valid value is stored in the
50
+ preferredValue property. If a valid value is already set up for this property (with overlapping effective dates)
51
+ then the valid value is updated. Async Version.
52
+
53
+ Parameters
54
+ ----------
55
+ property_name : str
56
+ The name of the property for which the valid metadata value is being set up.
57
+ type_name : str
58
+ The name of the type for the valid metadata value.
59
+ body : dict
60
+ The body of the request containing the details of the valid metadata value.
61
+ server : str, optional
62
+ The name of the server where the valid metadata value is being set up.
63
+ If not provided, the default server name will be used.
64
+
65
+ Returns
66
+ -------
67
+
68
+ Notes
69
+ -----
70
+
71
+ Payload structure similar to:
72
+ {
73
+ "displayName": "",
74
+ "description": "",
75
+ "preferredValue": "",
76
+ "dataType": "",
77
+ "isCaseSensitive": false,
78
+ "isDeprecated" : false
79
+ }
80
+ """
81
+ server = self.server_name if server is None else server
82
+
83
+ url = (f"{self.platform_url}/servers/{server}/api/open-metadata/valid-metadata/setup-value/{property_name}?"
84
+ f"typeName={type_name}")
85
+
86
+ await self._async_make_request("POST", url, body)
87
+ return
88
+
89
+ def setup_valid_metadata_value(self, property_name: str, type_name: str, body: dict,
90
+ server: str = None):
91
+ """ Create or update the valid value for a particular open metadata property name. If the typeName is null,
92
+ this valid value applies to properties of this name from all types. The valid value is stored in the
93
+ preferredValue property. If a valid value is already set up for this property (with overlapping effective dates)
94
+ then the valid value is updated.
95
+
96
+ Parameters
97
+ ----------
98
+ property_name : str
99
+ The name of the property for which the valid metadata value is being set up.
100
+ type_name : str
101
+ The name of the type for the valid metadata value.
102
+ body : dict
103
+ The body of the request containing the details of the valid metadata value.
104
+ server : str, optional
105
+ The name of the server where the valid metadata value is being set up.
106
+ If not provided, the default server name will be used.
107
+
108
+ Returns
109
+ -------
110
+ str
111
+ The GUID of the valid metadata value if it was successfully set up, or "GUID failed to be returned"
112
+ if the GUID was not returned in the response.
113
+
114
+ Notes
115
+ -----
116
+
117
+ Payload structure similar to:
118
+ {
119
+ "displayName": "",
120
+ "description": "",
121
+ "preferredValue": "",
122
+ "dataType": "",
123
+ "isCaseSensitive": false,
124
+ "isDeprecated" : false,
125
+ "additionalProperties": {
126
+ "colour": "purple"
127
+ }
128
+ }
129
+ """
130
+ loop = asyncio.get_event_loop()
131
+ loop.run_until_complete(self._async_setup_valid_metadata_value(property_name, type_name,
132
+ body, server))
133
+ return
134
+
135
+ async def _async_setup_valid_metadata_map_name(self, property_name: str, type_name: str, body: dict,
136
+ server: str = None):
137
+ """ Create or update the valid value for a name that can be stored in a particular open metadata property name.
138
+ This property is of type map from name to string. The mapName is stored in the preferredValue property of
139
+ validMetadataValue. If the typeName is null, this valid value applies to properties of this name from any
140
+ open metadata type. If a valid value is already set up for this property (with overlapping effective dates)
141
+ then the valid value is updated. Async Version.
142
+
143
+ Parameters
144
+ ----------
145
+ property_name : str
146
+ The name of the property to setup metadata map.
147
+ type_name : str
148
+ The type name of the property.
149
+ body : dict
150
+ The metadata map setup data.
151
+ server : str, optional
152
+ The name of the server to setup the metadata map. If not provided, the default server name will be used.
153
+
154
+ Returns
155
+ -------
156
+ None
157
+ This method does not return any value.
158
+
159
+ Notes
160
+ -----
161
+
162
+ Body strycture similar to:
163
+
164
+ {
165
+ "displayName": "",
166
+ "description": "",
167
+ "preferredValue": "put mapName value here",
168
+ "dataType": "",
169
+ "isCaseSensitive": false,
170
+ "isDeprecated" : false
171
+ }
172
+
173
+ """
174
+ server = self.server_name if server is None else server
175
+
176
+ url = (f"{self.platform_url}/servers/{server}/api/open-metadata/valid-metadata/setup-map-name/{property_name}?"
177
+ f"typeName={type_name}")
178
+
179
+ await self._async_make_request("POST", url, body)
180
+ return
181
+
182
+ async def _async_setup_valid_metadata_type_value(self, property_name: str, type_name: str, map_name: str,
183
+ server: str = None):
184
+ pass
185
+
186
+ async def _async_clear_valid_metadata_value(self, property_name: str, type_name: str, map_name: str,
187
+ server: str = None):
188
+ pass
189
+
190
+ async def _async_clear_valid_metadata_map_value(self, property_name: str, type_name: str, map_name: str,
191
+ preferred_value: str, server: str = None):
192
+ pass
193
+
194
+ async def _async_validate_metadata_value(self, property_name: str, type_name: str, actual_value: str,
195
+ server: str = None):
196
+ pass
197
+
198
+ async def _async_validate_metadata_map_name(self, property_name: str, type_name: str, map_name: str,
199
+ server: str = None):
200
+ pass
201
+
202
+ async def _async_validate_metadata_map_value(self, property_name: str, type_name: str, actual_value: str,
203
+ server: str = None):
204
+ pass
205
+
206
+ async def _async_validate_metadata_map_name(self, property_name: str, type_name: str, map_name: str,
207
+ server: str = None):
208
+ pass
209
+
210
+ async def _async_get_valid_metadata_value(self, property_name: str, type_name: str, preferred_value: str,
211
+ server: str = None):
212
+ pass
213
+
214
+ async def _async_get_valid_metadata_map_name(self, property_name: str, type_name: str, map_name: str,
215
+ server: str = None):
216
+ pass
217
+
218
+ async def _async_get_valid_metadata_map_value(self, property_name: str, type_name: str, map_name: str,
219
+ preferred_value: str, server: str = None):
220
+ pass
221
+
58
222
  async def _async_get_valid_metadata_values(self, property_name: str, type_name: str = None,
59
223
  server_name: str = None,
60
- start_value: int = 0,page_size: int = None) -> list | str:
224
+ start_value: int = 0, page_size: int = None) -> list | str:
61
225
  """ Retrieve list of values for the property. Async version.
62
226
 
63
227
  Parameters
@@ -93,15 +257,14 @@ class ValidMetadataManager(Client):
93
257
  if page_size is None:
94
258
  page_size = self.page_size
95
259
 
96
-
97
260
  url = (f"{self.platform_url}/servers/{server_name}{self.command_base}/get-valid-metadata-values/{property_name}"
98
261
  f"?typeName={type_name}&startFrom={start_value}&pageSize={page_size}")
99
262
 
100
263
  resp = await self._async_make_request("GET", url)
101
- return resp.json().get("elementList","No elements found")
264
+ return resp.json().get("elementList", "No elements found")
102
265
 
103
266
  def get_valid_metadata_values(self, property_name: str, type_name: str = None,
104
- server_name: str = None) -> list | str:
267
+ server_name: str = None) -> list | str:
105
268
  """ Retrieve list of values for the property.
106
269
 
107
270
  Parameters
@@ -134,7 +297,7 @@ class ValidMetadataManager(Client):
134
297
  """
135
298
  loop = asyncio.get_event_loop()
136
299
  resp = loop.run_until_complete(self._async_get_valid_metadata_values(property_name, type_name,
137
- server_name)),
300
+ server_name))
138
301
  return resp
139
302
 
140
303
  async def _async_get_valid_metadata_value(self, property_name: str, type_name: str, preferred_value: str,
@@ -142,7 +305,6 @@ class ValidMetadataManager(Client):
142
305
  if server_name is None:
143
306
  server_name = self.server_name
144
307
 
145
-
146
308
  url = (f"{self.platform_url}/servers/{server_name}{self.command_base}/get-value/{property_name}"
147
309
  f"?typeName={type_name}&preferredValue={preferred_value}")
148
310
 
@@ -155,16 +317,16 @@ class ValidMetadataManager(Client):
155
317
 
156
318
  Parameters
157
319
  ----------
158
- classification: str
159
- The classification of the collection to inspect.
160
- server_name : str, optional
320
+ property_name: str
321
+ The property name of the valid metadata value to retrieve
322
+ type_name: str
323
+ Type of the metadata value to retrieve
324
+ preferred_value: str
325
+ The preferred value of the valid metadata value to retrieve
326
+ server_name : str, opt
161
327
  The name of the server to configure.
162
328
  If not provided, the server name associated with the instance is used.
163
- start_from: int, [default=0], optional
164
- When multiple pages of results are available, the page number to start from.
165
- page_size: int, [default=None]
166
- The number of items to return in a single page. If not specified, the default will be taken from
167
- the class instance.
329
+
168
330
  Returns
169
331
  -------
170
332
  List | str
@@ -187,8 +349,7 @@ class ValidMetadataManager(Client):
187
349
  preferred_value, server_name)),
188
350
  return resp
189
351
 
190
-
191
- async def _async_get_consistent_metadata_values(self, property_name:str, type_name:str, map_name: str,
352
+ async def _async_get_consistent_metadata_values(self, property_name: str, type_name: str, map_name: str,
192
353
  preferred_value: str, server_name: str = None,
193
354
  start_from: int = 0, page_size: int = None) -> list | str:
194
355
  """ Retrieve all the consistent valid values for the requested property. Async version.
@@ -240,7 +401,7 @@ class ValidMetadataManager(Client):
240
401
  resp = await self._async_make_request("GET", url)
241
402
  return resp.json()
242
403
 
243
- def get_consistent_metadata_values(self, property_name:str, type_name:str, map_name: str,
404
+ def get_consistent_metadata_values(self, property_name: str, type_name: str, map_name: str,
244
405
  preferred_value: str, server_name: str = None,
245
406
  start_from: int = 0, page_size: int = None) -> list | str:
246
407
  """ Retrieve all the consistent valid values for the requested property.
@@ -282,11 +443,12 @@ class ValidMetadataManager(Client):
282
443
  """
283
444
  loop = asyncio.get_event_loop()
284
445
  resp = loop.run_until_complete(
285
- self._async_get_consistent_metadata_values(property_name,type_name,
286
- map_name,preferred_value,
287
- server_name,start_from,page_size)
446
+ self._async_get_consistent_metadata_values(property_name, type_name,
447
+ map_name, preferred_value,
448
+ server_name, start_from, page_size)
288
449
  )
289
450
  return resp
451
+
290
452
  #
291
453
  # Get all ...
292
454
  #
@@ -559,7 +721,7 @@ class ValidMetadataManager(Client):
559
721
  #
560
722
  # Get valid ...
561
723
  #
562
- async def _async_get_valid_relationship_types(self, entity_type:str, server_name: str = None) -> list | str:
724
+ async def _async_get_valid_relationship_types(self, entity_type: str, server_name: str = None) -> list | str:
563
725
  """ Returns all the TypeDefs for relationships that can be attached to the requested entity type.
564
726
  Async version.
565
727
 
@@ -597,7 +759,7 @@ class ValidMetadataManager(Client):
597
759
  resp = await self._async_make_request("GET", url)
598
760
  return resp.json().get("typeDefs", "No TypeDefs Found")
599
761
 
600
- def get_valid_relationship_types(self, entity_type:str, server_name: str = None) -> list | str:
762
+ def get_valid_relationship_types(self, entity_type: str, server_name: str = None) -> list | str:
601
763
  """ Returns all the TypeDefs for relationships that can be attached to the requested entity type.
602
764
  Async version.
603
765
 
@@ -629,11 +791,11 @@ class ValidMetadataManager(Client):
629
791
  loop = asyncio.get_event_loop()
630
792
  resp = loop.run_until_complete(
631
793
  self._async_get_valid_relationship_types(entity_type,
632
- server_name)
794
+ server_name)
633
795
  )
634
796
  return resp
635
797
 
636
- async def _async_get_valid_classification_types(self, entity_type:str, server_name: str = None) -> list | str:
798
+ async def _async_get_valid_classification_types(self, entity_type: str, server_name: str = None) -> list | str:
637
799
  """ Returns all the TypeDefs for classifications that can be attached to the requested entity type.
638
800
  Async version.
639
801
 
@@ -671,7 +833,7 @@ class ValidMetadataManager(Client):
671
833
  resp = await self._async_make_request("GET", url)
672
834
  return resp.json().get("typeDefs", "No TypeDefs Found")
673
835
 
674
- def get_valid_classification_types(self, entity_type:str, server_name: str = None) -> list | str:
836
+ def get_valid_classification_types(self, entity_type: str, server_name: str = None) -> list | str:
675
837
  """ Returns all the TypeDefs for relationships that can be attached to the requested entity type.
676
838
  Async version.
677
839
 
@@ -703,11 +865,11 @@ class ValidMetadataManager(Client):
703
865
  loop = asyncio.get_event_loop()
704
866
  resp = loop.run_until_complete(
705
867
  self._async_get_valid_classification_types(entity_type,
706
- server_name)
868
+ server_name)
707
869
  )
708
870
  return resp
709
871
 
710
- async def _async_get_typedef_by_name(self, entity_type:str, server_name: str = None) -> dict | str:
872
+ async def _async_get_typedef_by_name(self, entity_type: str, server_name: str = None) -> dict | str:
711
873
  """ Return the TypeDef identified by the unique name.
712
874
  Async version.
713
875
 
@@ -744,7 +906,7 @@ class ValidMetadataManager(Client):
744
906
  resp = await self._async_make_request("GET", url)
745
907
  return resp.json().get("typeDef", "No TypeDefs Found")
746
908
 
747
- def get_typedef_by_name(self, entity_type:str, server_name: str = None) -> dict | str:
909
+ def get_typedef_by_name(self, entity_type: str, server_name: str = None) -> dict | str:
748
910
  """ Return the TypeDef identified by the unique name.
749
911
 
750
912
  Parameters
@@ -776,4 +938,3 @@ class ValidMetadataManager(Client):
776
938
  resp = loop.run_until_complete(
777
939
  self._async_get_typedef_by_name(entity_type, server_name))
778
940
  return resp
779
-