pyegeria 5.4.4.8__py3-none-any.whl → 5.4.6__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 (211) hide show
  1. commands/cat/dr_egeria_command_help.py +0 -0
  2. commands/cat/exp_list_glossaries.py +0 -0
  3. commands/cat/get_collection.py +0 -0
  4. commands/cat/get_project_dependencies.py +0 -0
  5. commands/cat/get_project_structure.py +0 -0
  6. commands/cat/list_assets.py +0 -0
  7. commands/cat/list_cert_types.py +0 -0
  8. commands/cat/list_collections.py +0 -0
  9. commands/cat/list_data_designer.py +0 -0
  10. commands/cat/list_data_structures_full.py +0 -0
  11. commands/cat/list_deployed_servers.py +0 -0
  12. commands/cat/list_glossaries.py +0 -0
  13. commands/cat/list_projects.py +0 -0
  14. commands/cat/list_tech_types.py +0 -0
  15. commands/cat/list_terms.py +0 -0
  16. commands/cat/list_todos.py +0 -0
  17. commands/cli/egeria.py +0 -0
  18. commands/my/list_my_profile.py +0 -0
  19. commands/my/list_my_roles.py +0 -0
  20. commands/my/monitor_my_todos.py +0 -0
  21. commands/my/monitor_open_todos.py +0 -0
  22. commands/ops/list_archives.py +0 -0
  23. commands/ops/list_catalog_targets.py +0 -0
  24. commands/ops/monitor_asset_events.py +0 -0
  25. commands/ops/monitor_engine_activity.py +0 -0
  26. commands/ops/monitor_engine_activity_c.py +0 -0
  27. commands/ops/monitor_gov_eng_status.py +0 -0
  28. commands/ops/monitor_integ_daemon_status.py +0 -0
  29. commands/ops/monitor_platform_status.py +0 -0
  30. commands/ops/monitor_server_startup.py +0 -0
  31. commands/ops/monitor_server_status.py +0 -0
  32. commands/ops/orig_monitor_server_list.py +0 -0
  33. commands/ops/orig_monitor_server_status.py +0 -0
  34. commands/ops/table_integ_daemon_status.py +0 -0
  35. commands/tech/get_guid_info.py +0 -0
  36. commands/tech/get_tech_details.py +0 -0
  37. commands/tech/list_anchored_elements.py +0 -0
  38. commands/tech/list_asset_types.py +0 -0
  39. commands/tech/list_gov_action_processes.py +0 -0
  40. commands/tech/list_information_supply_chains.py +0 -0
  41. commands/tech/list_registered_services.py +0 -0
  42. commands/tech/list_relationship_types.py +0 -0
  43. commands/tech/list_relationships.py +0 -0
  44. commands/tech/list_solution_blueprints.py +0 -0
  45. commands/tech/list_solution_components.py +0 -0
  46. commands/tech/list_solution_roles.py +0 -0
  47. commands/tech/list_valid_metadata_values.py +0 -0
  48. md_processing/__init__.py +2 -0
  49. md_processing/dr_egeria.py +7 -4
  50. md_processing/md_commands/data_designer_commands.py +8 -3
  51. md_processing/md_commands/product_manager_commands.py +115 -12
  52. md_processing/md_commands/view_commands.py +3 -0
  53. md_processing/md_processing_utils/md_processing_constants.py +2 -1
  54. pyegeria/__init__.py +1 -0
  55. pyegeria/_client_new.py +1 -1
  56. pyegeria/_output_formats.py +50 -8
  57. pyegeria/automated_curation.py +122 -15
  58. pyegeria/collection_manager.py +28 -2
  59. pyegeria/data_designer.py +3 -3
  60. pyegeria/format_set_executor.py +159 -0
  61. pyegeria/mcp_adapter.py +110 -0
  62. pyegeria/mcp_server.py +176 -0
  63. pyegeria/project_manager.py +1 -1
  64. pyegeria/reference_data.py +1 -1
  65. pyegeria/x_action_author_omvs.py +1 -1
  66. {pyegeria-5.4.4.8.dist-info → pyegeria-5.4.6.dist-info}/METADATA +26 -29
  67. pyegeria-5.4.6.dist-info/RECORD +174 -0
  68. {pyegeria-5.4.4.8.dist-info → pyegeria-5.4.6.dist-info}/WHEEL +2 -1
  69. pyegeria-5.4.6.dist-info/entry_points.txt +105 -0
  70. pyegeria-5.4.6.dist-info/top_level.txt +3 -0
  71. commands/README.md +0 -47
  72. commands/cat/README.md +0 -16
  73. commands/cat/debug_log.2025-09-14_11-03-29_316193.log.zip +0 -0
  74. commands/cat/debug_log.2025-09-15_19-06-37_086464.log.zip +0 -0
  75. commands/cat/debug_log.2025-09-20_11-10-54_418109.log.zip +0 -0
  76. commands/cli/debug_log +0 -0
  77. commands/cli/txt_custom_v2.tcss +0 -19
  78. commands/doc/README.md +0 -145
  79. commands/doc/Visual Command Reference/README.md +0 -511
  80. commands/doc/Visual Command Reference/cat/show/assets/asset-graph 2024-11-20 at 15.56.42.png +0 -0
  81. commands/doc/Visual Command Reference/cat/show/assets/assets-in-domain 2024-11-20 at 15.49.55@2x.png +0 -0
  82. commands/doc/Visual Command Reference/cat/show/assets/elements-of-type 2024-11-20 at 16.01.35.png +0 -0
  83. commands/doc/Visual Command Reference/cat/show/assets/tech-type-elements 2024-11-20 at 16.05.05.png +0 -0
  84. commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-data-catalogs 2024-12-17 at 15.43.27@2x.png +0 -0
  85. commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-data-catalogs-2024-11-20 at 16.17.43@2x.png +0 -0
  86. commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-schemas 2024-11-25 at 20.14.50@2x.png +0 -0
  87. commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-schemas 2024-12-17 at 15.48.38@2x.png +0 -0
  88. commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-servers 2024-11-25 at 20.21.25@2x.png +0 -0
  89. commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-servers 2024-12-17 at 15.52.16@2x.png +0 -0
  90. commands/doc/Visual Command Reference/cat/show/deployed-data/deployed_databases 2024-12-16 at 16.40.31@2x.png +0 -0
  91. commands/doc/Visual Command Reference/cat/show/glossary/list-glossaries 2024-11-25 at 20.30.02.png +0 -0
  92. commands/doc/Visual Command Reference/cat/show/glossary/list-terms 2024-11-25 at 20.32.11.png +0 -0
  93. commands/doc/Visual Command Reference/cat/show/info/asset-types 2024-11-25 at 20.34.19@2x.png +0 -0
  94. commands/doc/Visual Command Reference/cat/show/info/certification-types 2024-11-25 at 20.37.07.png +0 -0
  95. commands/doc/Visual Command Reference/cat/show/info/collection-graph 2024-12-12 at 11.33.18@2x.png +0 -0
  96. commands/doc/Visual Command Reference/cat/show/info/list-collections 2024-12-10 at 14.25.51@2x.png +0 -0
  97. commands/doc/Visual Command Reference/cat/show/info/list-todos 2024-12-12 at 11.46.30@2x.png +0 -0
  98. commands/doc/Visual Command Reference/cat/show/info/list-user-ids 2024-12-12 at 11.51.09@2x.png +0 -0
  99. commands/doc/Visual Command Reference/cat/show/info/tech-types 2024-12-12 at 11.37.20@2x.png +0 -0
  100. commands/doc/Visual Command Reference/cat/show/projects/project_dependencies 2024-12-14 at 16.24.39@2x.png +0 -0
  101. commands/doc/Visual Command Reference/cat/show/projects/project_structure 2024-12-14 at 16.21.35@2x.png +0 -0
  102. commands/doc/Visual Command Reference/cat/show/projects/projects 2024-12-14 at 16.18.10@2x.png +0 -0
  103. commands/doc/Visual Command Reference/hey_egeria tui 2024-12-16 at 16.58.22@2x.png +0 -0
  104. commands/doc/Visual Command Reference/my/show/my_profile 2024-12-14 at 16.29.27@2x.png +0 -0
  105. commands/doc/Visual Command Reference/my/show/my_roles 2024-12-14 at 16.32.10@2x.png +0 -0
  106. commands/doc/Visual Command Reference/my/show/my_todos 2024-12-15 at 16.24.13@2x.png +0 -0
  107. commands/doc/Visual Command Reference/my/show/open_todos 2024-12-14 at 16.36.12@2x.png +0 -0
  108. commands/doc/Visual Command Reference/ops/show/engines/list_engine_activity compressed 2024-12-15 at 16.48.48@2x.png +0 -0
  109. commands/doc/Visual Command Reference/ops/show/engines/monitor_engine_activity 2024-12-15 at 16.32.55@2x.png +0 -0
  110. commands/doc/Visual Command Reference/ops/show/engines/monitor_engine_activity compressed 2024-12-15 at 16.38.29@2x.png +0 -0
  111. commands/doc/Visual Command Reference/ops/show/engines/monitor_engine_status 2024-12-15 at 16.51.26.jpeg +0 -0
  112. commands/doc/Visual Command Reference/ops/show/integrations/monitor_integration_daemon_status 2024-12-15 at 16.57.12@2x.png +0 -0
  113. commands/doc/Visual Command Reference/ops/show/integrations/monitor_integration_targets 2024-12-15 at 17.02.19@2x.png +0 -0
  114. commands/doc/Visual Command Reference/ops/show/platforms/monitor_platform_status 2024-12-15 at 19.53.18@2x.png +0 -0
  115. commands/doc/Visual Command Reference/ops/show/servers/monitor_server_status 2024-12-15 at 19.59.39@2x.png +0 -0
  116. commands/doc/Visual Command Reference/ops/show/servers/monitor_server_status full 2024-12-15 at 20.01.57@2x.png +0 -0
  117. commands/doc/Visual Command Reference/ops/show/servers/monitor_startup_servers 2024-12-15 at 19.56.07@2x.png +0 -0
  118. commands/doc/Visual Command Reference/tech/show/elements/get_anchored_elements 2024-12-15 at 21.25.41@2x.png +0 -0
  119. commands/doc/Visual Command Reference/tech/show/elements/get_elements_of_om_type 2024-12-16 at 14.39.59@2x.png +0 -0
  120. commands/doc/Visual Command Reference/tech/show/elements/info_for_guid 2024-12-16 at 11.35.29@2x.png +0 -0
  121. commands/doc/Visual Command Reference/tech/show/elements/list_elements_by_om-type 2024-12-16 at 14.24.18@2x.png +0 -0
  122. 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
  123. 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
  124. commands/doc/Visual Command Reference/tech/show/elements/related_elements 2024-12-16 at 14.55.01@2x.png +0 -0
  125. commands/doc/Visual Command Reference/tech/show/elements/show_related_specifications 2024-12-16 at 15.04.55@2x.png +0 -0
  126. commands/doc/Visual Command Reference/tech/show/tech-info/asset_types 2024-12-16 at 15.10.16@2x.png +0 -0
  127. commands/doc/Visual Command Reference/tech/show/tech-info/detailed_governance_action_processes 2024-12-16 at 15.16.26@2x.png +0 -0
  128. commands/doc/Visual Command Reference/tech/show/tech-info/governance_action_processes 2024-12-16 at 15.13.01@2x.png +0 -0
  129. commands/doc/Visual Command Reference/tech/show/tech-info/registered_services 2024-12-16 at 16.44.54@2x.png +0 -0
  130. commands/doc/Visual Command Reference/tech/show/tech-info/relationship_types 2024-12-16 at 16.20.34@2x.png +0 -0
  131. commands/doc/Visual Command Reference/tech/show/tech-info/relationship_types 2024-12-19 at 10.51.54@2x.png +0 -0
  132. commands/doc/Visual Command Reference/tech/show/tech-info/valid_metadata_values 2024-12-16 at 15.31.56@2x.png +0 -0
  133. 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
  134. commands/doc/Visual Command Reference/tech/show/tech-types/list_technology_types 2024-12-16 at 15.39.20@2x.png +0 -0
  135. commands/doc/Visual Command Reference/tech/show/tech-types/tech_type_details 2024-12-16 at 15.37.21@2x.png +0 -0
  136. commands/doc/Visual Command Reference/tech/show/tech-types/tech_type_templates 2024-12-16 at 16.11.48@2x.png +0 -0
  137. commands/doc/glossary/basic-glossary-tui.md +0 -109
  138. commands/doc/glossary/images/delete-glossary-step1 2024-11-06 at 15.47.23@2x.png +0 -0
  139. commands/doc/glossary/images/delete-glossary-step2 2024-11-06 at 15.51.29@2x.png +0 -0
  140. commands/doc/glossary/images/delete-glossary-step3 2024-11-06 at 15.53.19@2x.png +0 -0
  141. commands/doc/glossary/images/delete-glossary-step4 2024-11-06 at 15.55.11@2x.png +0 -0
  142. commands/doc/glossary/images/out-create-glossary example 2024-11-05 at 20.38.04@2x.png +0 -0
  143. commands/doc/glossary/images/out-create-term 2024-11-06 at 20.48.29.png +0 -0
  144. commands/doc/glossary/images/out-delete-term 2024-11-07 at 03.57.25.png +0 -0
  145. commands/doc/glossary/images/out-display-terms-for-glossary-test 2024-11-06 at 20.51.28.png +0 -0
  146. commands/doc/glossary/images/out-export-example 2024-11-07 at 09.54.57.png +0 -0
  147. commands/doc/glossary/images/out-exported-terms 2024-11-06 at 21.06.32.png +0 -0
  148. commands/doc/glossary/images/out-glossary-list example 2024-11-05 at 20.41.02@2x.png +0 -0
  149. commands/doc/glossary/images/out-import-terms 2024-11-07 at 08.15.18.png +0 -0
  150. commands/doc/glossary/images/out-list-all-terms 2024-11-06 at 16.22.20@2x.png +0 -0
  151. commands/doc/glossary/images/out-list-terms-for-example 2024-11-06 at 16.40.12.png +0 -0
  152. commands/doc/glossary/images/out-list-terms-second 2024-11-06 at 16.45.13.png +0 -0
  153. commands/doc/glossary/images/out-pipx install pyegeria 2024-11-10 at 18.12.21.png +0 -0
  154. commands/doc/glossary/images/out-server-status-full 2024-11-10 at 18.25.14.png +0 -0
  155. commands/doc/glossary/images/out-servers-status 2024-11-10 at 18.15.42.png +0 -0
  156. commands/doc/glossary/images/out-upsert-import 2024-11-07 at 19.37.00.png +0 -0
  157. commands/doc/glossary/images/tui-2024-11-10 at 18.26.29.png +0 -0
  158. commands/doc/glossary/images/tui-create-glossary example 2024-11-05 at 20.34.24@2x.png +0 -0
  159. commands/doc/glossary/images/tui-create-term 2024-11-06 at 20.46.35.png +0 -0
  160. commands/doc/glossary/images/tui-delete-term 2024-11-07 at 03.51.57.png +0 -0
  161. commands/doc/glossary/images/tui-display-terms-for-example 2024-11-06 at 20.56.49.png +0 -0
  162. commands/doc/glossary/images/tui-export-example 2024-11-07 at 09.52.59.png +0 -0
  163. commands/doc/glossary/images/tui-hey-egeria 2024-11-10 at 18.31.01.png +0 -0
  164. commands/doc/glossary/images/tui-import-upsert-example 2024-11-07 at 10.08.37.png +0 -0
  165. commands/doc/glossary/images/tui-list-terms-second 2024-11-06 at 16.46.34.png +0 -0
  166. commands/doc/glossary/images/tui-load-archive.png +0 -0
  167. commands/doc/glossary/images/tui-server-status-full 2024-11-10 at 19.14.36.png +0 -0
  168. commands/doc/glossary/images/tui-show-glossaries 2024-11-07 at 20.00.05.png +0 -0
  169. commands/doc/glossary/images/tui-show-glossary-terms 2024-11-05 at 19.37.53@2x.png +0 -0
  170. commands/doc/glossary/images/tui-upsert 2024-11-07 at 11.49.04.png +0 -0
  171. commands/doc/glossary/images/upsert-example.om-terms 2024-11-07 at 11.44.05.png +0 -0
  172. commands/doc/hey_egeria: a pyegeria command line interface/README.md +0 -346
  173. commands/doc/hey_egeria: a pyegeria command line interface/images/CleanShot 2024-11-18 at 21.32.03@2x.png +0 -0
  174. commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731421782704.png +0 -0
  175. commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731422134920.png +0 -0
  176. commands/doc/hey_egeria: a pyegeria command line interface/images/hey_egeria 2024-11-12 at 20.38.43.png +0 -0
  177. commands/doc/hey_egeria: a pyegeria command line interface/images/hey_egeria cat 2024-11-12 at 21.41.43.png +0 -0
  178. commands/doc/hey_egeria: a pyegeria command line interface/images/out-integ-status-list 2024-11-12 at 16.45.26.png +0 -0
  179. 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
  180. commands/doc/hey_egeria: a pyegeria command line interface/images/out-server-status 2024-11-10 at 18.15.42@2x.png +0 -0
  181. 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
  182. commands/doc/hey_egeria: a pyegeria command line interface/images/short-cut commands 2024-11-12 at 22.22.13.png +0 -0
  183. commands/doc/hey_egeria: a pyegeria command line interface/images/tui-hey-egeria.png +0 -0
  184. commands/doc/hey_egeria: a pyegeria command line interface/images/tui-integration-status-paging.png +0 -0
  185. commands/doc/hey_egeria: a pyegeria command line interface/images/tui-load-archive 2024-11-10 at 19.19.09@2x.png +0 -0
  186. 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
  187. commands/doc/hey_egeria: a pyegeria command line interface/images/tui-show-server-status-full 2024-11-10.png +0 -0
  188. commands/doc/hey_egeria: a pyegeria command line interface/images/tui-status-paging 2024-11-12 at 16.26.14@2x.png +0 -0
  189. commands/my/README.md +0 -17
  190. commands/ops/README.md +0 -24
  191. commands/tech/README.md +0 -24
  192. md_processing/.obsidian/app.json +0 -1
  193. md_processing/.obsidian/appearance.json +0 -1
  194. md_processing/.obsidian/community-plugins.json +0 -1
  195. md_processing/.obsidian/core-plugins.json +0 -33
  196. md_processing/.obsidian/workspace.json +0 -167
  197. md_processing/data/commands-working.json +0 -34850
  198. md_processing/data/commands.json +0 -51697
  199. md_processing/data/generated_format_sets.json +0 -4137
  200. md_processing/dr-egeria-outbox/DataStruct-DrE-2025-09-19-22-35-57.md +0 -46
  201. md_processing/dr-egeria-outbox/Digital Products-2025-09-21-16-52-50.md +0 -51
  202. md_processing/dr-egeria-outbox/Digital-Product-Catalog-2025-09-21-16-55-19.md +0 -77
  203. md_processing/dr_egeria_inbox/glossary_creation_experiment.ipynb +0 -341
  204. md_processing/md_processing_utils/debug_log +0 -84
  205. md_processing/md_processing_utils/dr-egeria-help-2025-09-09T11:10:03.md +0 -3305
  206. md_processing/md_processing_utils/dr-egeria-help-2025-09-10T14:49:49.md +0 -3460
  207. md_processing/md_processing_utils/dr-egeria-help-2025-09-10T14:57:46.md +0 -472
  208. pyegeria/README.md +0 -35
  209. pyegeria-5.4.4.8.dist-info/RECORD +0 -308
  210. pyegeria-5.4.4.8.dist-info/entry_points.txt +0 -105
  211. {pyegeria-5.4.4.8.dist-info → pyegeria-5.4.6.dist-info/licenses}/LICENSE +0 -0
@@ -1,472 +0,0 @@
1
- # Generating glossary entries for the documented commands
2
-
3
-
4
- This file contains generated Dr.Egeria commands to generate glossary term entries describing
5
- each Dr.Egeria command.
6
-
7
- > Usage: Before executing this file, make sure you have a glossary named `Egeria-Markdown`
8
- > already created. If you Need to create one, you can use the
9
- # Create Term
10
- ## Term Name
11
-
12
- Create Governance Driver
13
-
14
- ## Description
15
-
16
- A motivating topic leading to governance work.
17
-
18
- ## Glossary
19
-
20
- Egeria-Markdown
21
-
22
- ## Folders
23
-
24
- Writing Dr.Egeria Markdown
25
-
26
- ## Usage
27
-
28
- | **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
29
- |-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
30
- | **Display Name** | True | True | False | None | Name of the definition. | False | |
31
- | **Identity** | True | True | False | None | Distinguishes the entity. | False | |
32
- | Summary | False | True | False | None | Summary of the definition. | False | |
33
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
34
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
35
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
36
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
37
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
38
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
39
- | Scope | False | True | False | None | Scope of the definition. | False | |
40
- | Importance | False | True | False | None | Importance of the definition. | False | |
41
- | Implications | False | True | False | None | List of implications. | False | |
42
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
43
- | Results | False | True | False | None | A list of expected results. | False | |
44
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
45
- | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
46
- | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
47
- | GUID | False | False | True | None | A system generated unique identifier. | True | |
48
-
49
-
50
- ___
51
-
52
- # Create Term
53
- ## Term Name
54
-
55
- Create Governance Strategy
56
-
57
- ## Description
58
-
59
- The strategy used in the development of the governance domains activities. How the governance domain supports the business strategy.
60
-
61
- ## Glossary
62
-
63
- Egeria-Markdown
64
-
65
- ## Folders
66
-
67
- Writing Dr.Egeria Markdown
68
-
69
- ## Usage
70
-
71
- | **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
72
- |-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
73
- | **Display Name** | True | True | False | None | Name of the definition. | False | |
74
- | **Identity** | True | True | False | None | Distinguishes the entity. | False | |
75
- | Summary | False | True | False | None | Summary of the definition. | False | |
76
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
77
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
78
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
79
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
80
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
81
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
82
- | Scope | False | True | False | None | Scope of the definition. | False | |
83
- | Importance | False | True | False | None | Importance of the definition. | False | |
84
- | Implications | False | True | False | None | List of implications. | False | |
85
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
86
- | Results | False | True | False | None | A list of expected results. | False | |
87
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
88
- | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
89
- | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
90
- | GUID | False | False | True | None | A system generated unique identifier. | True | |
91
-
92
-
93
- ___
94
-
95
- # Create Term
96
- ## Term Name
97
-
98
- Create Business Imperative
99
-
100
- ## Description
101
-
102
- The BusinessImperative entity defines a business goal that is critical to the success of the organization.
103
-
104
- ## Glossary
105
-
106
- Egeria-Markdown
107
-
108
- ## Folders
109
-
110
- Writing Dr.Egeria Markdown
111
-
112
- ## Usage
113
-
114
- | **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
115
- |-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
116
- | **Display Name** | True | True | False | None | Name of the definition. | False | |
117
- | **Identity** | True | True | False | None | Distinguishes the entity. | False | |
118
- | Summary | False | True | False | None | Summary of the definition. | False | |
119
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
120
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
121
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
122
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
123
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
124
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
125
- | Scope | False | True | False | None | Scope of the definition. | False | |
126
- | Importance | False | True | False | None | Importance of the definition. | False | |
127
- | Implications | False | True | False | None | List of implications. | False | |
128
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
129
- | Results | False | True | False | None | A list of expected results. | False | |
130
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
131
- | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
132
- | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
133
- | GUID | False | False | True | None | A system generated unique identifier. | True | |
134
-
135
-
136
- ___
137
-
138
- # Create Term
139
- ## Term Name
140
-
141
- Create Regulation
142
-
143
- ## Description
144
-
145
- Defines a relevant legal regulation that the business operation must comply with. Often regulations are divided into regulation articles.
146
-
147
- ## Glossary
148
-
149
- Egeria-Markdown
150
-
151
- ## Folders
152
-
153
- Writing Dr.Egeria Markdown
154
-
155
- ## Usage
156
-
157
- | **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
158
- |-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
159
- | **Display Name** | True | True | False | None | Name of the definition. | False | |
160
- | **Identity** | True | True | False | None | Distinguishes the entity. | False | |
161
- | Summary | False | True | False | None | Summary of the definition. | False | |
162
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
163
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
164
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
165
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
166
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
167
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
168
- | Scope | False | True | False | None | Scope of the definition. | False | |
169
- | Importance | False | True | False | None | Importance of the definition. | False | |
170
- | Regulation Source | False | True | False | None | The source of the regulation - often, an authority. | False | |
171
- | Regulators | False | True | False | None | A list of regulators. | False | |
172
- | Implications | False | True | False | None | List of implications. | False | |
173
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
174
- | Results | False | True | False | None | A list of expected results. | False | |
175
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
176
- | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
177
- | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
178
- | GUID | False | False | True | None | A system generated unique identifier. | True | |
179
-
180
-
181
- ___
182
-
183
- # Create Term
184
- ## Term Name
185
-
186
- Create Regulation Article
187
-
188
- ## Description
189
-
190
- A RegulationArticle entity is an article in a regulation. Dividing a regulation simplifies planning and execution.
191
-
192
- ## Glossary
193
-
194
- Egeria-Markdown
195
-
196
- ## Folders
197
-
198
- Writing Dr.Egeria Markdown
199
-
200
- ## Usage
201
-
202
- | **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
203
- |-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
204
- | **Display Name** | True | True | False | None | Name of the definition. | False | |
205
- | **Identity** | True | True | False | None | Distinguishes the entity. | False | |
206
- | Summary | False | True | False | None | Summary of the definition. | False | |
207
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
208
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
209
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
210
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
211
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
212
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
213
- | Scope | False | True | False | None | Scope of the definition. | False | |
214
- | Importance | False | True | False | None | Importance of the definition. | False | |
215
- | Implications | False | True | False | None | List of implications. | False | |
216
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
217
- | Results | False | True | False | None | A list of expected results. | False | |
218
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
219
- | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
220
- | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
221
- | GUID | False | False | True | None | A system generated unique identifier. | True | |
222
-
223
-
224
- ___
225
-
226
- # Create Term
227
- ## Term Name
228
-
229
- Create Threat Definition
230
-
231
- ## Description
232
-
233
- The Threat entity describes a particular threat to the organization's operations that must either be guarded against or accommodated to reduce its impact.
234
-
235
- ## Glossary
236
-
237
- Egeria-Markdown
238
-
239
- ## Folders
240
-
241
- Writing Dr.Egeria Markdown
242
-
243
- ## Usage
244
-
245
- | **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
246
- |-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
247
- | **Display Name** | True | True | False | None | Name of the definition. | False | |
248
- | **Identity** | True | True | False | None | Distinguishes the entity. | False | |
249
- | Summary | False | True | False | None | Summary of the definition. | False | |
250
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
251
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
252
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
253
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
254
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
255
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
256
- | Scope | False | True | False | None | Scope of the definition. | False | |
257
- | Importance | False | True | False | None | Importance of the definition. | False | |
258
- | Implications | False | True | False | None | List of implications. | False | |
259
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
260
- | Results | False | True | False | None | A list of expected results. | False | |
261
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
262
- | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
263
- | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
264
- | GUID | False | False | True | None | A system generated unique identifier. | True | |
265
-
266
-
267
- ___
268
-
269
- # Create Term
270
- ## Term Name
271
-
272
- Create Governance Policy
273
-
274
- ## Description
275
-
276
- Policies created in response to governance drivers. There are several types of policies.
277
-
278
- ## Glossary
279
-
280
- Egeria-Markdown
281
-
282
- ## Folders
283
-
284
- Writing Dr.Egeria Markdown
285
-
286
- ## Usage
287
-
288
- | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
289
- |---------------------|----------------|-----------|-----------|---------------|-------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------|
290
- | Display Name | True | True | False | None | Name of the definition. | False | |
291
- | Summary | False | True | False | None | Summary of the definition. | False | |
292
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
293
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
294
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
295
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
296
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
297
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
298
- | Scope | False | True | False | None | Scope of the definition. | False | |
299
- | Importance | False | True | False | None | Importance of the definition. | False | |
300
- | Implications | False | True | False | None | List of implications. | False | |
301
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
302
- | Results | False | True | False | None | A list of expected results. | False | |
303
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
304
- | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
305
- | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
306
- | GUID | False | False | True | None | A system generated unique identifier. | True | |
307
-
308
-
309
- ___
310
-
311
- # Create Term
312
- ## Term Name
313
-
314
- Create Governance Principle
315
-
316
- ## Description
317
-
318
- The GovernancePrinciple entity defines a policy that describes an end state that the organization aims to achieve.
319
-
320
- ## Glossary
321
-
322
- Egeria-Markdown
323
-
324
- ## Folders
325
-
326
- Writing Dr.Egeria Markdown
327
-
328
- ## Usage
329
-
330
- | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
331
- |---------------------|----------------|-----------|-----------|---------------|-------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------|
332
- | Display Name | True | True | False | None | Name of the definition. | False | |
333
- | Summary | False | True | False | None | Summary of the definition. | False | |
334
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
335
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
336
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
337
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
338
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
339
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
340
- | Scope | False | True | False | None | Scope of the definition. | False | |
341
- | Importance | False | True | False | None | Importance of the definition. | False | |
342
- | Implications | False | True | False | None | List of implications. | False | |
343
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
344
- | Results | False | True | False | None | A list of expected results. | False | |
345
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
346
- | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
347
- | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
348
- | GUID | False | False | True | None | A system generated unique identifier. | True | |
349
-
350
-
351
- ___
352
-
353
- # Create Term
354
- ## Term Name
355
-
356
- Create Governance Obligation
357
-
358
- ## Description
359
-
360
- The GovernanceObligation entity defines a policy that describes a requirement that must be met.
361
-
362
- ## Glossary
363
-
364
- Egeria-Markdown
365
-
366
- ## Folders
367
-
368
- Writing Dr.Egeria Markdown
369
-
370
- ## Usage
371
-
372
- | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
373
- |---------------------|----------------|-----------|-----------|---------------|-------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------|
374
- | Display Name | True | True | False | None | Name of the definition. | False | |
375
- | Summary | False | True | False | None | Summary of the definition. | False | |
376
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
377
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
378
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
379
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
380
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
381
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
382
- | Scope | False | True | False | None | Scope of the definition. | False | |
383
- | Importance | False | True | False | None | Importance of the definition. | False | |
384
- | Implications | False | True | False | None | List of implications. | False | |
385
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
386
- | Results | False | True | False | None | A list of expected results. | False | |
387
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
388
- | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
389
- | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
390
- | GUID | False | False | True | None | A system generated unique identifier. | True | |
391
-
392
-
393
- ___
394
-
395
- # Create Term
396
- ## Term Name
397
-
398
- Create Governance Approach
399
-
400
- ## Description
401
-
402
- The GovernanceApproach entity defines a policy that describes a method that should be used for a particular activity.
403
-
404
- ## Glossary
405
-
406
- Egeria-Markdown
407
-
408
- ## Folders
409
-
410
- Writing Dr.Egeria Markdown
411
-
412
- ## Usage
413
-
414
- | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
415
- |---------------------|----------------|-----------|-----------|---------------|-------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------|
416
- | Display Name | True | True | False | None | Name of the definition. | False | |
417
- | Summary | False | True | False | None | Summary of the definition. | False | |
418
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
419
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
420
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
421
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
422
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
423
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
424
- | Scope | False | True | False | None | Scope of the definition. | False | |
425
- | Importance | False | True | False | None | Importance of the definition. | False | |
426
- | Implications | False | True | False | None | List of implications. | False | |
427
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
428
- | Results | False | True | False | None | A list of expected results. | False | |
429
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
430
- | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
431
- | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
432
- | GUID | False | False | True | None | A system generated unique identifier. | True | |
433
-
434
-
435
- ___
436
-
437
- # Create Term
438
- ## Term Name
439
-
440
- Create Governance Control
441
-
442
- ## Description
443
-
444
- A governance control describes how a particular governance policy should be implemented. There are many types of controls.
445
-
446
- ## Glossary
447
-
448
- Egeria-Markdown
449
-
450
- ## Folders
451
-
452
- Writing Dr.Egeria Markdown
453
-
454
- ## Usage
455
-
456
- | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
457
- |---------------------|----------------|-----------|-----------|---------------|----------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------|
458
- | Display Name | True | True | False | None | Name of the definition. | False | |
459
- | Summary | False | True | False | None | Summary of the definition. | False | |
460
- | Description | False | True | False | None | Description of the contents of the definition. | False | |
461
- | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
462
- | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
463
- | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
464
- | Version Identifier | False | True | False | None | Published version identifier. | False | |
465
- | Usage | False | True | False | None | How the governance definition will be used. | False | |
466
- | Scope | False | True | False | None | Scope of the definition. | False | |
467
- | Importance | False | True | False | None | Importance of the definition. | False | |
468
- | Implications | False | True | False | None | List of implications. | False | |
469
- | Outcomes | False | True | False | None | List of desired outcomes. | False | |
470
- | Results | False | True | False | None | A list of expected results. | False | |
471
- | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
472
- | User Defined Status | False | True | False | None | Only valid if Product Status | | |
pyegeria/README.md DELETED
@@ -1,35 +0,0 @@
1
- <!-- SPDX-License-Identifier: CC-BY-4.0 -->
2
- <!-- Copyright Contributors to the ODPi Egeria project. -->
3
-
4
- ![Egeria Logo](https://egeria-project.org/assets/images/egeria-header.png)
5
-
6
- [![GitHub](https://img.shields.io/github/license/odpi/egeria)](LICENSE)
7
-
8
-
9
- # pyegeria: a python client for Egeria
10
-
11
- This is a package for easily using the Egeria
12
- open metadata environment from python. Details about the
13
- open source Egeria project can be found at [Egeria Project](https://egeria-project.org).
14
-
15
- This package is in active development. There is initial
16
- support for many of Egeria's services including configuration and operation. This client depends on
17
- This release supports Egeria 5.1 and above - although most of the functions may work on earlier versions of Egeria as well.
18
-
19
- The code is organized to mimic the existing Egeria Java Client structure.
20
-
21
- WARNING: files that start with "X" are in-progress placeholders that are not meant to be used..they will mature and
22
- evolve.
23
-
24
- All feedback is welcome. Please engage via our [community](http://egeria-project.org/guides/community/),
25
- team calls, or via github issues in this repo. If interested in contributing,
26
- you can engage via the community or directly reach out to
27
- [dan.wolfson\@pdr-associates.com](mailto:dan.wolfson@pdr-associates.com?subject=pyegeria).
28
-
29
- This is a learning experience.
30
-
31
-
32
-
33
- ----
34
- License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
35
- Copyright Contributors to the ODPi Egeria project.