pyegeria 0.2.4__py3-none-any.whl → 5.3.0.dev3__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 (239) hide show
  1. pyegeria/README.md +35 -0
  2. pyegeria/__init__.py +345 -14
  3. pyegeria/_client.py +376 -126
  4. pyegeria/_deprecated_gov_engine.py +451 -0
  5. pyegeria/_exceptions.py +6 -6
  6. pyegeria/_globals.py +7 -1
  7. pyegeria/_validators.py +9 -6
  8. pyegeria/asset_catalog_omvs.py +807 -0
  9. pyegeria/automated_curation_omvs.py +3760 -0
  10. pyegeria/classification_manager_omvs.py +5238 -0
  11. pyegeria/collection_manager_omvs.py +2727 -0
  12. pyegeria/commands/README.md +47 -0
  13. pyegeria/commands/__init__.py +22 -0
  14. pyegeria/commands/cat/README.md +16 -0
  15. pyegeria/commands/cat/__init__.py +1 -0
  16. pyegeria/commands/cat/exp_list_glossaries.py +156 -0
  17. pyegeria/commands/cat/get_asset_graph.py +319 -0
  18. pyegeria/commands/cat/get_collection.py +148 -0
  19. pyegeria/commands/cat/get_project_dependencies.py +168 -0
  20. pyegeria/commands/cat/get_project_structure.py +168 -0
  21. pyegeria/commands/cat/get_tech_type_elements.py +174 -0
  22. pyegeria/commands/cat/glossary_actions.py +362 -0
  23. pyegeria/commands/cat/list_assets.py +176 -0
  24. pyegeria/commands/cat/list_cert_types.py +194 -0
  25. pyegeria/commands/cat/list_collections.py +162 -0
  26. pyegeria/commands/cat/list_deployed_catalogs.py +217 -0
  27. pyegeria/commands/cat/list_deployed_database_schemas.py +251 -0
  28. pyegeria/commands/cat/list_deployed_databases.py +202 -0
  29. pyegeria/commands/cat/list_glossaries.py +150 -0
  30. pyegeria/commands/cat/list_projects.py +221 -0
  31. pyegeria/commands/cat/list_servers_deployed_imp.py +158 -0
  32. pyegeria/commands/cat/list_tech_type_elements.py +190 -0
  33. pyegeria/commands/cat/list_tech_types.py +140 -0
  34. pyegeria/commands/cat/list_terms.py +242 -0
  35. pyegeria/commands/cat/list_todos.py +189 -0
  36. pyegeria/commands/cat/list_user_ids.py +145 -0
  37. pyegeria/commands/cli/__init__.py +13 -0
  38. pyegeria/commands/cli/egeria.py +1844 -0
  39. pyegeria/commands/cli/egeria_cat.py +638 -0
  40. pyegeria/commands/cli/egeria_login_tui.py +313 -0
  41. pyegeria/commands/cli/egeria_my.py +248 -0
  42. pyegeria/commands/cli/egeria_ops.py +502 -0
  43. pyegeria/commands/cli/egeria_tech.py +618 -0
  44. pyegeria/commands/cli/ops_config.py +45 -0
  45. pyegeria/commands/cli/txt_custom_v2.tcss +19 -0
  46. pyegeria/commands/doc/README.md +145 -0
  47. pyegeria/commands/doc/Visual Command Reference/README.md +511 -0
  48. pyegeria/commands/doc/Visual Command Reference/cat/show/assets/asset-graph 2024-11-20 at 15.56.42.png +0 -0
  49. pyegeria/commands/doc/Visual Command Reference/cat/show/assets/assets-in-domain 2024-11-20 at 15.49.55@2x.png +0 -0
  50. pyegeria/commands/doc/Visual Command Reference/cat/show/assets/elements-of-type 2024-11-20 at 16.01.35.png +0 -0
  51. pyegeria/commands/doc/Visual Command Reference/cat/show/assets/tech-type-elements 2024-11-20 at 16.05.05.png +0 -0
  52. pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-data-catalogs 2024-12-17 at 15.43.27@2x.png +0 -0
  53. pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-data-catalogs-2024-11-20 at 16.17.43@2x.png +0 -0
  54. pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-schemas 2024-11-25 at 20.14.50@2x.png +0 -0
  55. pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-schemas 2024-12-17 at 15.48.38@2x.png +0 -0
  56. pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-servers 2024-11-25 at 20.21.25@2x.png +0 -0
  57. pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-servers 2024-12-17 at 15.52.16@2x.png +0 -0
  58. pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed_databases 2024-12-16 at 16.40.31@2x.png +0 -0
  59. pyegeria/commands/doc/Visual Command Reference/cat/show/glossary/list-glossaries 2024-11-25 at 20.30.02.png +0 -0
  60. pyegeria/commands/doc/Visual Command Reference/cat/show/glossary/list-terms 2024-11-25 at 20.32.11.png +0 -0
  61. pyegeria/commands/doc/Visual Command Reference/cat/show/info/asset-types 2024-11-25 at 20.34.19@2x.png +0 -0
  62. pyegeria/commands/doc/Visual Command Reference/cat/show/info/certification-types 2024-11-25 at 20.37.07.png +0 -0
  63. pyegeria/commands/doc/Visual Command Reference/cat/show/info/collection-graph 2024-12-12 at 11.33.18@2x.png +0 -0
  64. pyegeria/commands/doc/Visual Command Reference/cat/show/info/list-collections 2024-12-10 at 14.25.51@2x.png +0 -0
  65. pyegeria/commands/doc/Visual Command Reference/cat/show/info/list-todos 2024-12-12 at 11.46.30@2x.png +0 -0
  66. pyegeria/commands/doc/Visual Command Reference/cat/show/info/list-user-ids 2024-12-12 at 11.51.09@2x.png +0 -0
  67. pyegeria/commands/doc/Visual Command Reference/cat/show/info/tech-types 2024-12-12 at 11.37.20@2x.png +0 -0
  68. pyegeria/commands/doc/Visual Command Reference/cat/show/projects/project_dependencies 2024-12-14 at 16.24.39@2x.png +0 -0
  69. pyegeria/commands/doc/Visual Command Reference/cat/show/projects/project_structure 2024-12-14 at 16.21.35@2x.png +0 -0
  70. pyegeria/commands/doc/Visual Command Reference/cat/show/projects/projects 2024-12-14 at 16.18.10@2x.png +0 -0
  71. pyegeria/commands/doc/Visual Command Reference/hey_egeria tui 2024-12-16 at 16.58.22@2x.png +0 -0
  72. pyegeria/commands/doc/Visual Command Reference/my/show/my_profile 2024-12-14 at 16.29.27@2x.png +0 -0
  73. pyegeria/commands/doc/Visual Command Reference/my/show/my_roles 2024-12-14 at 16.32.10@2x.png +0 -0
  74. pyegeria/commands/doc/Visual Command Reference/my/show/my_todos 2024-12-15 at 16.24.13@2x.png +0 -0
  75. pyegeria/commands/doc/Visual Command Reference/my/show/open_todos 2024-12-14 at 16.36.12@2x.png +0 -0
  76. pyegeria/commands/doc/Visual Command Reference/ops/show/engines/list_engine_activity compressed 2024-12-15 at 16.48.48@2x.png +0 -0
  77. pyegeria/commands/doc/Visual Command Reference/ops/show/engines/monitor_engine_activity 2024-12-15 at 16.32.55@2x.png +0 -0
  78. pyegeria/commands/doc/Visual Command Reference/ops/show/engines/monitor_engine_activity compressed 2024-12-15 at 16.38.29@2x.png +0 -0
  79. pyegeria/commands/doc/Visual Command Reference/ops/show/engines/monitor_engine_status 2024-12-15 at 16.51.26.jpeg +0 -0
  80. pyegeria/commands/doc/Visual Command Reference/ops/show/integrations/monitor_integration_daemon_status 2024-12-15 at 16.57.12@2x.png +0 -0
  81. pyegeria/commands/doc/Visual Command Reference/ops/show/integrations/monitor_integration_targets 2024-12-15 at 17.02.19@2x.png +0 -0
  82. pyegeria/commands/doc/Visual Command Reference/ops/show/platforms/monitor_platform_status 2024-12-15 at 19.53.18@2x.png +0 -0
  83. pyegeria/commands/doc/Visual Command Reference/ops/show/servers/monitor_server_status 2024-12-15 at 19.59.39@2x.png +0 -0
  84. pyegeria/commands/doc/Visual Command Reference/ops/show/servers/monitor_server_status full 2024-12-15 at 20.01.57@2x.png +0 -0
  85. pyegeria/commands/doc/Visual Command Reference/ops/show/servers/monitor_startup_servers 2024-12-15 at 19.56.07@2x.png +0 -0
  86. pyegeria/commands/doc/Visual Command Reference/tech/show/elements/get_anchored_elements 2024-12-15 at 21.25.41@2x.png +0 -0
  87. pyegeria/commands/doc/Visual Command Reference/tech/show/elements/get_elements_of_om_type 2024-12-16 at 14.39.59@2x.png +0 -0
  88. pyegeria/commands/doc/Visual Command Reference/tech/show/elements/info_for_guid 2024-12-16 at 11.35.29@2x.png +0 -0
  89. pyegeria/commands/doc/Visual Command Reference/tech/show/elements/list_elements_by_om-type 2024-12-16 at 14.24.18@2x.png +0 -0
  90. pyegeria/commands/doc/Visual Command Reference/tech/show/elements/list_elements_by_om-type extended 2024-12-16 at 14.28.46@2x.png +0 -0
  91. pyegeria/commands/doc/Visual Command Reference/tech/show/elements/list_elements_of_om_type_by_classification 2024-12-16 at 14.35.26@2x.png +0 -0
  92. pyegeria/commands/doc/Visual Command Reference/tech/show/elements/related_elements 2024-12-16 at 14.55.01@2x.png +0 -0
  93. pyegeria/commands/doc/Visual Command Reference/tech/show/elements/show_related_specifications 2024-12-16 at 15.04.55@2x.png +0 -0
  94. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/asset_types 2024-12-16 at 15.10.16@2x.png +0 -0
  95. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/detailed_governance_action_processes 2024-12-16 at 15.16.26@2x.png +0 -0
  96. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/governance_action_processes 2024-12-16 at 15.13.01@2x.png +0 -0
  97. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/registered_services 2024-12-16 at 16.44.54@2x.png +0 -0
  98. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/relationship_types 2024-12-16 at 16.20.34@2x.png +0 -0
  99. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/relationship_types 2024-12-19 at 10.51.54@2x.png +0 -0
  100. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/valid_metadata_values 2024-12-16 at 15.31.56@2x.png +0 -0
  101. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-types/list_tech_type_template_specs 2024-12-16 at 16.03.22@2x.png +0 -0
  102. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-types/list_technology_types 2024-12-16 at 15.39.20@2x.png +0 -0
  103. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-types/tech_type_details 2024-12-16 at 15.37.21@2x.png +0 -0
  104. pyegeria/commands/doc/Visual Command Reference/tech/show/tech-types/tech_type_templates 2024-12-16 at 16.11.48@2x.png +0 -0
  105. pyegeria/commands/doc/glossary/basic-glossary-tui.md +109 -0
  106. pyegeria/commands/doc/glossary/images/delete-glossary-step1 2024-11-06 at 15.47.23@2x.png +0 -0
  107. pyegeria/commands/doc/glossary/images/delete-glossary-step2 2024-11-06 at 15.51.29@2x.png +0 -0
  108. pyegeria/commands/doc/glossary/images/delete-glossary-step3 2024-11-06 at 15.53.19@2x.png +0 -0
  109. pyegeria/commands/doc/glossary/images/delete-glossary-step4 2024-11-06 at 15.55.11@2x.png +0 -0
  110. pyegeria/commands/doc/glossary/images/out-create-glossary example 2024-11-05 at 20.38.04@2x.png +0 -0
  111. pyegeria/commands/doc/glossary/images/out-create-term 2024-11-06 at 20.48.29.png +0 -0
  112. pyegeria/commands/doc/glossary/images/out-delete-term 2024-11-07 at 03.57.25.png +0 -0
  113. pyegeria/commands/doc/glossary/images/out-display-terms-for-glossary-test 2024-11-06 at 20.51.28.png +0 -0
  114. pyegeria/commands/doc/glossary/images/out-export-example 2024-11-07 at 09.54.57.png +0 -0
  115. pyegeria/commands/doc/glossary/images/out-exported-terms 2024-11-06 at 21.06.32.png +0 -0
  116. pyegeria/commands/doc/glossary/images/out-glossary-list example 2024-11-05 at 20.41.02@2x.png +0 -0
  117. pyegeria/commands/doc/glossary/images/out-import-terms 2024-11-07 at 08.15.18.png +0 -0
  118. pyegeria/commands/doc/glossary/images/out-list-all-terms 2024-11-06 at 16.22.20@2x.png +0 -0
  119. pyegeria/commands/doc/glossary/images/out-list-terms-for-example 2024-11-06 at 16.40.12.png +0 -0
  120. pyegeria/commands/doc/glossary/images/out-list-terms-second 2024-11-06 at 16.45.13.png +0 -0
  121. pyegeria/commands/doc/glossary/images/out-pipx install pyegeria 2024-11-10 at 18.12.21.png +0 -0
  122. pyegeria/commands/doc/glossary/images/out-server-status-full 2024-11-10 at 18.25.14.png +0 -0
  123. pyegeria/commands/doc/glossary/images/out-servers-status 2024-11-10 at 18.15.42.png +0 -0
  124. pyegeria/commands/doc/glossary/images/out-upsert-import 2024-11-07 at 19.37.00.png +0 -0
  125. pyegeria/commands/doc/glossary/images/tui-2024-11-10 at 18.26.29.png +0 -0
  126. pyegeria/commands/doc/glossary/images/tui-create-glossary example 2024-11-05 at 20.34.24@2x.png +0 -0
  127. pyegeria/commands/doc/glossary/images/tui-create-term 2024-11-06 at 20.46.35.png +0 -0
  128. pyegeria/commands/doc/glossary/images/tui-delete-term 2024-11-07 at 03.51.57.png +0 -0
  129. pyegeria/commands/doc/glossary/images/tui-display-terms-for-example 2024-11-06 at 20.56.49.png +0 -0
  130. pyegeria/commands/doc/glossary/images/tui-export-example 2024-11-07 at 09.52.59.png +0 -0
  131. pyegeria/commands/doc/glossary/images/tui-hey-egeria 2024-11-10 at 18.31.01.png +0 -0
  132. pyegeria/commands/doc/glossary/images/tui-import-upsert-example 2024-11-07 at 10.08.37.png +0 -0
  133. pyegeria/commands/doc/glossary/images/tui-list-terms-second 2024-11-06 at 16.46.34.png +0 -0
  134. pyegeria/commands/doc/glossary/images/tui-load-archive.png +0 -0
  135. pyegeria/commands/doc/glossary/images/tui-server-status-full 2024-11-10 at 19.14.36.png +0 -0
  136. pyegeria/commands/doc/glossary/images/tui-show-glossaries 2024-11-07 at 20.00.05.png +0 -0
  137. pyegeria/commands/doc/glossary/images/tui-show-glossary-terms 2024-11-05 at 19.37.53@2x.png +0 -0
  138. pyegeria/commands/doc/glossary/images/tui-upsert 2024-11-07 at 11.49.04.png +0 -0
  139. pyegeria/commands/doc/glossary/images/upsert-example.om-terms 2024-11-07 at 11.44.05.png +0 -0
  140. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/README.md +346 -0
  141. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/CleanShot 2024-11-18 at 21.32.03@2x.png +0 -0
  142. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731421782704.png +0 -0
  143. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731422134920.png +0 -0
  144. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/hey_egeria 2024-11-12 at 20.38.43.png +0 -0
  145. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/hey_egeria cat 2024-11-12 at 21.41.43.png +0 -0
  146. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/out-integ-status-list 2024-11-12 at 16.45.26.png +0 -0
  147. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/out-integ-status-live 2024-11-12 at 16.44.12@2x.png +0 -0
  148. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/out-server-status 2024-11-10 at 18.15.42@2x.png +0 -0
  149. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/out-server-status-full 2024-11-10 at 18.25.14@2x.png +0 -0
  150. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/short-cut commands 2024-11-12 at 22.22.13.png +0 -0
  151. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-hey-egeria.png +0 -0
  152. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-integration-status-paging.png +0 -0
  153. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-load-archive 2024-11-10 at 19.19.09@2x.png +0 -0
  154. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-show-server-status 2024-11-10 at 18.52.01@2x.png +0 -0
  155. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-show-server-status-full 2024-11-10.png +0 -0
  156. pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-status-paging 2024-11-12 at 16.26.14@2x.png +0 -0
  157. pyegeria/commands/my/README.md +17 -0
  158. pyegeria/commands/my/__init__.py +0 -0
  159. pyegeria/commands/my/list_my_profile.py +163 -0
  160. pyegeria/commands/my/list_my_roles.py +151 -0
  161. pyegeria/commands/my/monitor_my_todos.py +205 -0
  162. pyegeria/commands/my/monitor_open_todos.py +175 -0
  163. pyegeria/commands/my/todo_actions.py +242 -0
  164. pyegeria/commands/ops/README.md +24 -0
  165. pyegeria/commands/ops/__init__.py +22 -0
  166. pyegeria/commands/ops/gov_server_actions.py +177 -0
  167. pyegeria/commands/ops/list_archives.py +161 -0
  168. pyegeria/commands/ops/list_catalog_targets.py +203 -0
  169. pyegeria/commands/ops/load_archive.py +75 -0
  170. pyegeria/commands/ops/monitor_asset_events.py +107 -0
  171. pyegeria/commands/ops/monitor_engine_activity.py +270 -0
  172. pyegeria/commands/ops/monitor_engine_activity_c.py +286 -0
  173. pyegeria/commands/ops/monitor_gov_eng_status.py +288 -0
  174. pyegeria/commands/ops/monitor_integ_daemon_status.py +321 -0
  175. pyegeria/commands/ops/monitor_platform_status.py +188 -0
  176. pyegeria/commands/ops/monitor_server_startup.py +117 -0
  177. pyegeria/commands/ops/monitor_server_status.py +182 -0
  178. pyegeria/commands/ops/orig_monitor_server_list.py +140 -0
  179. pyegeria/commands/ops/orig_monitor_server_status.py +124 -0
  180. pyegeria/commands/ops/refresh_integration_daemon.py +83 -0
  181. pyegeria/commands/ops/restart_integration_daemon.py +82 -0
  182. pyegeria/commands/ops/table_integ_daemon_status.py +237 -0
  183. pyegeria/commands/ops/x_engine_actions.py +76 -0
  184. pyegeria/commands/tech/README.md +24 -0
  185. pyegeria/commands/tech/__init__.py +0 -0
  186. pyegeria/commands/tech/get_element_info.py +144 -0
  187. pyegeria/commands/tech/get_guid_info.py +134 -0
  188. pyegeria/commands/tech/get_tech_details.py +173 -0
  189. pyegeria/commands/tech/get_tech_type_template.py +166 -0
  190. pyegeria/commands/tech/list_anchored_elements.py +205 -0
  191. pyegeria/commands/tech/list_asset_types.py +123 -0
  192. pyegeria/commands/tech/list_elements.py +168 -0
  193. pyegeria/commands/tech/list_elements_for_classification.py +171 -0
  194. pyegeria/commands/tech/list_elements_x.py +191 -0
  195. pyegeria/commands/tech/list_gov_action_processes.py +139 -0
  196. pyegeria/commands/tech/list_registered_services.py +180 -0
  197. pyegeria/commands/tech/list_related_elements.py +207 -0
  198. pyegeria/commands/tech/list_related_specification.py +169 -0
  199. pyegeria/commands/tech/list_relationship_types.py +164 -0
  200. pyegeria/commands/tech/list_relationships.py +179 -0
  201. pyegeria/commands/tech/list_tech_templates.py +360 -0
  202. pyegeria/commands/tech/list_valid_metadata_values.py +178 -0
  203. pyegeria/commands/tech/table_tech_templates.py +238 -0
  204. pyegeria/commands/tech/x_list_related_elements.py +165 -0
  205. pyegeria/core_omag_server_config.py +550 -313
  206. pyegeria/create_tech_guid_lists.py +105 -0
  207. pyegeria/egeria_cat_client.py +78 -0
  208. pyegeria/egeria_client.py +117 -0
  209. pyegeria/egeria_config_client.py +45 -0
  210. pyegeria/egeria_my_client.py +56 -0
  211. pyegeria/egeria_tech_client.py +93 -0
  212. pyegeria/feedback_manager_omvs.py +4573 -0
  213. pyegeria/full_omag_server_config.py +1337 -0
  214. pyegeria/glossary_browser_omvs.py +2507 -0
  215. pyegeria/glossary_manager_omvs.py +3597 -0
  216. pyegeria/mermaid_utilities.py +218 -0
  217. pyegeria/metadata_explorer_omvs.py +2371 -0
  218. pyegeria/my_profile_omvs.py +1021 -0
  219. pyegeria/platform_services.py +259 -218
  220. pyegeria/project_manager_omvs.py +1854 -0
  221. pyegeria/registered_info.py +111 -108
  222. pyegeria/runtime_manager_omvs.py +2299 -0
  223. pyegeria/server_operations.py +178 -71
  224. pyegeria/template_manager_omvs.py +1414 -0
  225. pyegeria/utils.py +75 -85
  226. pyegeria/valid_metadata_omvs.py +1911 -0
  227. pyegeria/x_action_author_omvs.py +200 -0
  228. pyegeria-5.3.0.dev3.dist-info/METADATA +70 -0
  229. pyegeria-5.3.0.dev3.dist-info/RECORD +232 -0
  230. {pyegeria-0.2.4.dist-info → pyegeria-5.3.0.dev3.dist-info}/WHEEL +1 -1
  231. pyegeria-5.3.0.dev3.dist-info/entry_points.txt +81 -0
  232. pyegeria/config.toml +0 -11
  233. pyegeria/curation_omvs.py +0 -458
  234. pyegeria/exceptions.py +0 -382
  235. pyegeria/glossary_omvs.py +0 -639
  236. pyegeria/gov_engine.py +0 -573
  237. pyegeria-0.2.4.dist-info/METADATA +0 -57
  238. pyegeria-0.2.4.dist-info/RECORD +0 -19
  239. {pyegeria-0.2.4.dist-info/licenses → pyegeria-5.3.0.dev3.dist-info}/LICENSE +0 -0
pyegeria/curation_omvs.py DELETED
@@ -1,458 +0,0 @@
1
- """
2
-
3
- This module contains the core OMAG configuration class and its methods.
4
-
5
- """
6
- from datetime import datetime
7
-
8
- # import json
9
- from pyegeria._client import Client, max_paging_size
10
- from pyegeria._globals import enable_ssl_check
11
- from pyegeria._validators import (
12
- validate_name,
13
- validate_guid,
14
- validate_url, validate_search_string,
15
- )
16
- from pyegeria.utils import body_slimmer
17
-
18
- class AutomatedCuration(Client):
19
- """
20
- This client provides methods to perform automated curation of assets.
21
-
22
- Methods:
23
-
24
-
25
- """
26
-
27
- def __init__(
28
- self,
29
- server_name: str,
30
- platform_url: str,
31
- token: str = None,
32
- user_id: str = None,
33
- user_pwd: str = None,
34
- verify_flag: bool = enable_ssl_check,
35
- ):
36
- self.curation_command_root: str
37
- Client.__init__(self, server_name, platform_url, user_id = user_id, token=token)
38
-
39
- self.curation_command_root = (
40
- self.platform_url
41
- + "/servers/" + server_name
42
- + "/api/open-metadata/automated-curation/engine-actions"
43
- )
44
-
45
- def get_engine_actions(self, server_name:str = None, start_from: str = 0, page_size: str = 0) -> [dict]:
46
- """ Get engine actions associated deployed on the server.
47
-
48
- Parameters:
49
- ----------
50
- server_name (str, optional):
51
- start_from (int, optional): The index to start retrieving processes from. Defaults to 0.
52
- page_size (int, optional): The number of processes to retrieve per page. Defaults to 0 (no pagination).
53
-
54
- Returns:
55
- -------
56
- List[str]: A list of JSON representations of governance action processes matching the provided name.
57
-
58
- Raises:
59
- ------
60
- InvalidParameterException: If the API response indicates an error (non-200 status code),
61
- this exception is raised with details from the response content.
62
-
63
- Note:
64
- ----
65
- Pagination of 0 defaults to server default.
66
-
67
- """
68
- url = (self.engine_command_root + "/engine-actions?startFrom=" +
69
- str(start_from) + "&pageSize=" + str(page_size))
70
- response = self.make_request("GET", url)
71
-
72
- if response.status_code != 200:
73
- return response.json() # should never get here?
74
-
75
- related_code = response.json().get("relatedHTTPCode")
76
- if related_code == 200:
77
- governanceActionElements = response.json().get('elements')
78
- return governanceActionElements
79
- else:
80
- raise InvalidParameterException(response.content)
81
- #
82
- # Glossaries
83
- #
84
- def find_glossaries(self, search_string: str, effective_time: str = None, starts_with: bool = False,
85
- ends_with:bool = False, ignore_case: bool = False, for_lineage:bool = False,
86
- for_duplicate_processing: bool = False, type_name: str= None,server_name: str = None,
87
- start_from: int = 0, page_size: int = None) -> list | str:
88
- """ Retrieve the list of glossary metadata elements that contain the search string.
89
- The search string is located in the request body and is interpreted as a plain string.
90
- The request parameters, startsWith, endsWith and ignoreCase can be used to allow a fuzzy search.
91
-
92
- Parameters
93
- ----------
94
- search_string: str,
95
- Search string to use to find matching glossaries. If the search string is '*' then all glossaries returned.
96
-
97
- effective_time: str, [default=None], optional
98
- Effective time of the query. If not specified will default to any time.
99
- server_name : str, optional
100
- The name of the server to configure.
101
- If not provided, the server name associated with the instance is used.
102
- starts_with : bool, [default=False], optional
103
- Starts with the supplied string.
104
- ends_with : bool, [default=False], optional
105
- Ends with the supplied string
106
- ignore_case : bool, [default=False], optional
107
- Ignore case when searching
108
- for_lineage : bool, [default=False], optional
109
-
110
- for_duplicate_processing : bool, [default=False], optional
111
- type_name: str, [default=None], optional
112
- An optional parameter indicating the subtype of the glossary to filter by.
113
- Values include 'ControlledGlossary', 'EditingGlossary', and 'StagingGlossary'
114
- Returns
115
- -------
116
- List | str
117
-
118
- A list of glossary definitions
119
-
120
- Raises
121
- ------
122
-
123
- InvalidParameterException
124
- If the client passes incorrect parameters on the request - such as bad URLs or invalid values
125
- PropertyServerException
126
- Raised by the server when an issue arises in processing a valid request
127
- NotAuthorizedException
128
- The principle specified by the user_id does not have authorization for the requested action
129
-
130
- """
131
- if server_name is None:
132
- server_name = self.server_name
133
- if page_size is None:
134
- page_size = self.page_size
135
- starts_with_s = str(starts_with).lower()
136
- ends_with_s = str(ends_with).lower()
137
- ignore_case_s = str(ignore_case).lower()
138
- for_lineage_s = str(for_lineage).lower()
139
- for_duplicate_processing_s = str(for_duplicate_processing).lower()
140
-
141
- validate_search_string(search_string)
142
-
143
- if search_string is '*':
144
- search_string = None
145
-
146
- body = {
147
- "class": "SearchStringRequestBody",
148
- "searchString": search_string,
149
- "effectiveTime": effective_time,
150
- "typeName" : type_name
151
- }
152
- body = body_slimmer(body)
153
- # print(f"\n\nBody is: \n{body}")
154
-
155
- url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/glossaries/"
156
- f"by-search-string?startFrom={start_from}&pageSize={page_size}&startsWith={starts_with_s}&"
157
- f"endsWith={ends_with_s}&ignoreCase={ignore_case_s}&forLineage={for_lineage_s}&"
158
- f"forDuplicateProcessing={for_duplicate_processing_s}")
159
-
160
- response = self.make_request("POST", url, body)
161
- return response.json().get("elementList","No glossaries found")
162
-
163
-
164
- def get_glossary_by_guid(self, glossary_guid: str, server_name: str = None) -> dict:
165
- """ Retrieves information about a glossary
166
- Parameters
167
- ----------
168
- glossary_guid : str
169
- Unique idetifier for the glossary
170
- server_name : str, optional
171
- The name of the server to get the configured access services for.
172
- If not provided, the server name associated with the instance is used.
173
- Returns
174
- -------
175
- dict
176
- The glossary definition associated with the glossary_guid
177
-
178
- Raises
179
- ------
180
- InvalidParameterException
181
- If the client passes incorrect parameters on the request - such as bad URLs or invalid values.
182
- PropertyServerException
183
- Raised by the server when an issue arises in processing a valid request.
184
- NotAuthorizedException
185
- The principle specified by the user_id does not have authorization for the requested action.
186
- Notes
187
- -----
188
- """
189
-
190
- if server_name is None:
191
- server_name = self.server_name
192
- validate_guid(glossary_guid)
193
-
194
- url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/glosaries/"
195
- f"{glossary_guid}/retrieve")
196
-
197
- response = self.make_request("GET", url)
198
- return response.json()
199
-
200
-
201
- def get_glossaries_by_name(self, glossary_name: str, effective_time: datetime = None, server_name: str = None,
202
- start_from: int = 0, page_size: int = None) -> dict | str:
203
- """ Retrieve the list of glossary metadata elements with an exactly matching qualified or display name.
204
- There are no wildcards supported on this request.
205
-
206
- Parameters
207
- ----------
208
- glossary_name: str,
209
- Name of the glossary to be retrieved
210
- effective_time: datetime, [default=None], optional
211
- Effective time of the query. If not specified will default to any effective time.
212
- server_name : str, optional
213
- The name of the server to configure.
214
- If not provided, the server name associated with the instance is used.
215
-
216
- Returns
217
- -------
218
- None
219
-
220
- Raises
221
- ------
222
-
223
- InvalidParameterException
224
- If the client passes incorrect parameters on the request - such as bad URLs or invalid values
225
- PropertyServerException
226
- Raised by the server when an issue arises in processing a valid request
227
- NotAuthorizedException
228
- The principle specified by the user_id does not have authorization for the requested action
229
- ConfigurationErrorException
230
- Raised when configuration parameters passed on earlier calls turn out to be
231
- invalid or make the new call invalid.
232
- """
233
- if server_name is None:
234
- server_name = self.server_name
235
- if page_size is None:
236
- page_size = self.page_size
237
- validate_name(glossary_name)
238
-
239
- if effective_time is None:
240
- body = {"name": glossary_name}
241
- else:
242
- body = {"name": glossary_name, "effectiveTime": effective_time}
243
-
244
- url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/glossaries/"
245
- f"by-name?startFrom={start_from}&pageSize={page_size}")
246
-
247
- response = self.make_request("POST", url, body)
248
- return response.json()
249
-
250
-
251
- def get_terms_for_glossary(self, glossary_guid: str, server_name: str = None, effective_time: datetime= None,
252
- start_from: int = 0, page_size: int = None) -> list | str:
253
- """ Retrieve the list of glossary terms associated with a glossary.
254
- The request body also supports the specification of an effective time for the query.
255
- Parameters
256
- ----------
257
- glossary_guid : str
258
- Unique idetifier for the glossary
259
- server_name : str, optional
260
- The name of the server to get the configured access services for.
261
- If not provided, the server name associated with the instance is used.
262
- effective_time : str, optional
263
- If specified, the query is performed as of the `effective_time`
264
- start_from: int, optional defaults to 0
265
- The page number to start retrieving elements from
266
- page_size : int, optional defaults to None
267
- The number of elements to retrieve
268
- Returns
269
- -------
270
- dict
271
- The glossary definition associated with the glossary_guid
272
-
273
- Raises
274
- ------
275
- InvalidParameterException
276
- If the client passes incorrect parameters on the request - such as bad URLs or invalid values.
277
- PropertyServerException
278
- Raised by the server when an issue arises in processing a valid request.
279
- NotAuthorizedException
280
- The principle specified by the user_id does not have authorization for the requested action.
281
- Notes
282
- -----
283
- """
284
-
285
- if server_name is None:
286
- server_name = self.server_name
287
- validate_guid(glossary_guid)
288
-
289
- if page_size is None:
290
- page_size = self.page_size
291
-
292
- url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/glossaries/"
293
- f"{glossary_guid}/terms/retrieve?startFrom={start_from}&pageSize={page_size}")
294
-
295
- if effective_time is not None:
296
- body = {
297
- "effectiveTime": str(effective_time)
298
- }
299
- response = self.make_request("POST", url, body)
300
- else:
301
- response = self.make_request("POST", url)
302
- return response.json().get("elementList","No terms found")
303
-
304
- def get_glossary_for_term(self, term_guid: str, server_name: str=None, effective_time: datetime = None,
305
- for_lineage: bool=False, for_duplicate_processing: bool=False) ->dict:
306
- if server_name is None:
307
- server_name = self.server_name
308
- validate_guid(term_guid)
309
- for_lineage_s = str(for_lineage).lower()
310
- for_duplicate_processing_s = str(for_duplicate_processing).lower()
311
-
312
- body = {
313
- "class" : "EffectiveTimeQueryRequestBody",
314
- "effectiveTime" : effective_time
315
- }
316
- url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/glossaries/"
317
- f"for-term/{term_guid}/retrieve?forLineage={for_lineage_s}&"
318
- f"forDuplicateProcessing={for_duplicate_processing_s}"
319
-
320
- )
321
-
322
- response = self.make_request("POST", url, body)
323
- return response.json()
324
-
325
-
326
- def get_terms_by_name(self, term: str, glossary_guid:str = None, status_filter: list=[], server_name: str=None,
327
- effective_time: datetime=None, for_lineage: bool=False, for_duplicate_processing: bool=False,
328
- start_from: int=0, page_size: int=None) ->list:
329
- if server_name is None:
330
- server_name = self.server_name
331
- if page_size is None:
332
- page_size = self.page_size
333
-
334
- validate_name(term)
335
-
336
- for_lineage_s = str(for_lineage).lower()
337
- for_duplicate_processing_s = str(for_duplicate_processing).lower()
338
-
339
-
340
- body = {
341
- "class": "GlossaryNameRequestBody",
342
- "glossaryGUID": glossary_guid,
343
- "name" : term,
344
- "effectiveTime": effective_time,
345
- "limitResultsByStatus" : status_filter
346
- }
347
- # body = body_slimmer(body)
348
-
349
-
350
- url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/glossaries/"
351
- f"terms/by-name?startFrom={start_from}&pageSize={page_size}&"
352
- f"&forLineage={for_lineage_s}&forDuplicateProcessing={for_duplicate_processing_s}")
353
-
354
- # print(f"\n\nURL is: \n {url}\n\nBody is: \n{body}")
355
-
356
- response = self.make_request("POST", url, body)
357
- return response.json().get("elementList","No terms found")
358
-
359
- def find_glossary_terms(self, search_string: str, glossary_guid: str = None, status_filter: list=[],
360
- effective_time: str = None, starts_with: bool = False,
361
- ends_with:bool = False, ignore_case: bool = False, for_lineage:bool = False,
362
- for_duplicate_processing: bool = False,server_name: str = None,
363
- start_from: int = 0, page_size: int = None) -> list | str:
364
-
365
- """ Retrieve the list of glossary term metadata elements that contain the search string.
366
-
367
- Parameters
368
- ----------
369
- search_string: str
370
- Search string to use to find matching glossaries. If the search string is '*' then all glossaries returned.
371
- glossary_guid str
372
- Identifier of the glossary to search within. If None, then all glossaries are searched.
373
- status_filter: list, default = [], optional
374
- Filters the results by the included Term statuses (such as 'ACTIVE', 'DRAFT'). If not specified,
375
- the results will not be filtered.
376
- effective_time: str, [default=None], optional
377
- Effective time of the query. If not specified will default to any time.
378
- If the effective time is not in the right format then it will be considered any.
379
- server_name : str, optional
380
- The name of the server to configure.
381
- If not provided, the server name associated with the instance is used.
382
- starts_with : bool, [default=False], optional
383
- Starts with the supplied string.
384
- ends_with : bool, [default=False], optional
385
- Ends with the supplied string
386
- ignore_case : bool, [default=False], optional
387
- Ignore case when searching
388
- for_lineage : bool, [default=False], optional
389
-
390
- for_duplicate_processing : bool, [default=False], optional
391
-
392
- start_from: str, [default=0], optional
393
- Page of results to start from
394
- page_size : int, optional
395
- Number of elements to return per page - if None, then default for class will be used.
396
-
397
- Returns
398
- -------
399
- List | str
400
-
401
- A list of term definitions
402
-
403
- Raises
404
- ------
405
- InvalidParameterException
406
- If the client passes incorrect parameters on the request - such as bad URLs or invalid values
407
- PropertyServerException
408
- Raised by the server when an issue arises in processing a valid request
409
- NotAuthorizedException
410
- The principle specified by the user_id does not have authorization for the requested action
411
-
412
- Notes
413
- -----
414
- The search string is located in the request body and is interpreted as a plain string.
415
- The request parameters, startsWith, endsWith and ignoreCase can be used to allow a fuzzy search.
416
- The request body also supports the specification of a glossaryGUID to restrict the search to within a single glossary.
417
- """
418
- if server_name is None:
419
- server_name = self.server_name
420
- if page_size is None:
421
- page_size = self.page_size
422
- if effective_time is None:
423
- effective_time = datetime.now().isoformat()
424
- starts_with_s = str(starts_with).lower()
425
- ends_with_s = str(ends_with).lower()
426
- ignore_case_s = str(ignore_case).lower()
427
- for_lineage_s = str(for_lineage).lower()
428
- for_duplicate_processing_s = str(for_duplicate_processing).lower()
429
- if search_string is '*':
430
- search_string = None
431
-
432
- # validate_search_string(search_string)
433
-
434
-
435
- body = {
436
- "class": "GlossarySearchStringRequestBody",
437
- "glossaryGUID": glossary_guid,
438
- "searchString": search_string,
439
- "effectiveTime": effective_time,
440
- "limitResultsByStatus": status_filter
441
- }
442
- # body = body_slimmer(body)
443
-
444
-
445
- url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/glossaries/"
446
- f"terms/by-search-string?startFrom={start_from}&pageSize={page_size}&startsWith={starts_with_s}&"
447
- f"endsWith={ends_with_s}&ignoreCase={ignore_case_s}&forLineage={for_lineage_s}&"
448
- f"forDuplicateProcessing={for_duplicate_processing_s}")
449
-
450
- print(f"\n\nURL is: \n {url}\n\nBody is: \n{body}")
451
-
452
- response = self.make_request("POST", url, body)
453
- return response.json().get("elementList","No terms found")
454
- # return response.text
455
-
456
- #
457
- # Catagories
458
- #