pyegeria 5.3.9.5__py3-none-any.whl → 5.3.9.7__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.
- {pyegeria/commands → commands}/cat/Dr-Egeria_md-orig.py +10 -11
- {pyegeria/commands → commands}/cat/dr_egeria_jupyter.py +4 -4
- {pyegeria/commands → commands}/cat/dr_egeria_md.py +36 -16
- {pyegeria/commands → commands}/cat/list_categories.py +3 -3
- {pyegeria/commands → commands}/cat/list_collections.py +59 -16
- commands/cat/list_data_structures.py +223 -0
- {pyegeria/commands → commands}/cat/list_glossaries.py +3 -3
- {pyegeria/commands → commands}/cat/list_terms.py +4 -4
- {pyegeria/commands → commands}/cli/__init__.py +1 -1
- {pyegeria/commands → commands}/cli/egeria.py +91 -87
- {pyegeria/commands → commands}/cli/egeria_cat.py +29 -29
- {pyegeria/commands → commands}/cli/egeria_login_tui.py +1 -1
- {pyegeria/commands → commands}/cli/egeria_my.py +8 -8
- {pyegeria/commands → commands}/cli/egeria_ops.py +24 -24
- {pyegeria/commands → commands}/cli/egeria_tech.py +34 -34
- commands/tech/generic_actions.py +74 -0
- {pyegeria/commands → commands}/tech/list_information_supply_chains.py +3 -1
- pyegeria/__init__.py +11 -9
- pyegeria/_client.py +2 -49
- pyegeria/collection_manager_omvs.py +484 -735
- pyegeria/data_designer_omvs.py +251 -103
- pyegeria/egeria_client.py +5 -0
- pyegeria/egeria_tech_client.py +10 -1
- pyegeria/glossary_browser_omvs.py +144 -260
- pyegeria/md_processing_helpers.py +1 -1
- pyegeria/md_processing_utils.py +114 -32
- pyegeria/md_processing_utils_orig.py +19 -19
- pyegeria/mermaid_utilities.py +2 -2
- pyegeria/output_formatter.py +389 -0
- {pyegeria-5.3.9.5.dist-info → pyegeria-5.3.9.7.dist-info}/METADATA +1 -1
- pyegeria-5.3.9.7.dist-info/RECORD +141 -0
- pyegeria-5.3.9.7.dist-info/entry_points.txt +99 -0
- pyegeria/commands/README.md +0 -47
- pyegeria/commands/__init__.py +0 -30
- pyegeria/commands/cat/dr_egeria_inbox/glossary_creation_experiment.ipynb +0 -341
- pyegeria/commands/doc/README.md +0 -145
- pyegeria/commands/doc/Visual Command Reference/README.md +0 -511
- pyegeria/commands/doc/Visual Command Reference/cat/show/assets/asset-graph 2024-11-20 at 15.56.42.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/assets/assets-in-domain 2024-11-20 at 15.49.55@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/assets/elements-of-type 2024-11-20 at 16.01.35.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/assets/tech-type-elements 2024-11-20 at 16.05.05.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-data-catalogs 2024-12-17 at 15.43.27@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-data-catalogs-2024-11-20 at 16.17.43@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-schemas 2024-11-25 at 20.14.50@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-schemas 2024-12-17 at 15.48.38@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-servers 2024-11-25 at 20.21.25@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed-servers 2024-12-17 at 15.52.16@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/deployed-data/deployed_databases 2024-12-16 at 16.40.31@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/glossary/list-glossaries 2024-11-25 at 20.30.02.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/glossary/list-terms 2024-11-25 at 20.32.11.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/info/asset-types 2024-11-25 at 20.34.19@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/info/certification-types 2024-11-25 at 20.37.07.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/info/collection-graph 2024-12-12 at 11.33.18@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/info/list-collections 2024-12-10 at 14.25.51@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/info/list-todos 2024-12-12 at 11.46.30@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/info/list-user-ids 2024-12-12 at 11.51.09@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/info/tech-types 2024-12-12 at 11.37.20@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/projects/project_dependencies 2024-12-14 at 16.24.39@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/projects/project_structure 2024-12-14 at 16.21.35@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/cat/show/projects/projects 2024-12-14 at 16.18.10@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/hey_egeria tui 2024-12-16 at 16.58.22@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/my/show/my_profile 2024-12-14 at 16.29.27@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/my/show/my_roles 2024-12-14 at 16.32.10@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/my/show/my_todos 2024-12-15 at 16.24.13@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/my/show/open_todos 2024-12-14 at 16.36.12@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/ops/show/engines/list_engine_activity compressed 2024-12-15 at 16.48.48@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/ops/show/engines/monitor_engine_activity 2024-12-15 at 16.32.55@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/ops/show/engines/monitor_engine_activity compressed 2024-12-15 at 16.38.29@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/ops/show/engines/monitor_engine_status 2024-12-15 at 16.51.26.jpeg +0 -0
- pyegeria/commands/doc/Visual Command Reference/ops/show/integrations/monitor_integration_daemon_status 2024-12-15 at 16.57.12@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/ops/show/integrations/monitor_integration_targets 2024-12-15 at 17.02.19@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/ops/show/platforms/monitor_platform_status 2024-12-15 at 19.53.18@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/ops/show/servers/monitor_server_status 2024-12-15 at 19.59.39@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/ops/show/servers/monitor_server_status full 2024-12-15 at 20.01.57@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/ops/show/servers/monitor_startup_servers 2024-12-15 at 19.56.07@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/tech/show/elements/get_anchored_elements 2024-12-15 at 21.25.41@2x.png +0 -0
- 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
- pyegeria/commands/doc/Visual Command Reference/tech/show/elements/info_for_guid 2024-12-16 at 11.35.29@2x.png +0 -0
- 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
- 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
- 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
- pyegeria/commands/doc/Visual Command Reference/tech/show/elements/related_elements 2024-12-16 at 14.55.01@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/tech/show/elements/show_related_specifications 2024-12-16 at 15.04.55@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/asset_types 2024-12-16 at 15.10.16@2x.png +0 -0
- 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
- pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/governance_action_processes 2024-12-16 at 15.13.01@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/registered_services 2024-12-16 at 16.44.54@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/relationship_types 2024-12-16 at 16.20.34@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/relationship_types 2024-12-19 at 10.51.54@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/tech/show/tech-info/valid_metadata_values 2024-12-16 at 15.31.56@2x.png +0 -0
- 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
- pyegeria/commands/doc/Visual Command Reference/tech/show/tech-types/list_technology_types 2024-12-16 at 15.39.20@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/tech/show/tech-types/tech_type_details 2024-12-16 at 15.37.21@2x.png +0 -0
- pyegeria/commands/doc/Visual Command Reference/tech/show/tech-types/tech_type_templates 2024-12-16 at 16.11.48@2x.png +0 -0
- pyegeria/commands/doc/glossary/basic-glossary-tui.md +0 -109
- pyegeria/commands/doc/glossary/images/delete-glossary-step1 2024-11-06 at 15.47.23@2x.png +0 -0
- pyegeria/commands/doc/glossary/images/delete-glossary-step2 2024-11-06 at 15.51.29@2x.png +0 -0
- pyegeria/commands/doc/glossary/images/delete-glossary-step3 2024-11-06 at 15.53.19@2x.png +0 -0
- pyegeria/commands/doc/glossary/images/delete-glossary-step4 2024-11-06 at 15.55.11@2x.png +0 -0
- pyegeria/commands/doc/glossary/images/out-create-glossary example 2024-11-05 at 20.38.04@2x.png +0 -0
- pyegeria/commands/doc/glossary/images/out-create-term 2024-11-06 at 20.48.29.png +0 -0
- pyegeria/commands/doc/glossary/images/out-delete-term 2024-11-07 at 03.57.25.png +0 -0
- pyegeria/commands/doc/glossary/images/out-display-terms-for-glossary-test 2024-11-06 at 20.51.28.png +0 -0
- pyegeria/commands/doc/glossary/images/out-export-example 2024-11-07 at 09.54.57.png +0 -0
- pyegeria/commands/doc/glossary/images/out-exported-terms 2024-11-06 at 21.06.32.png +0 -0
- pyegeria/commands/doc/glossary/images/out-glossary-list example 2024-11-05 at 20.41.02@2x.png +0 -0
- pyegeria/commands/doc/glossary/images/out-import-terms 2024-11-07 at 08.15.18.png +0 -0
- pyegeria/commands/doc/glossary/images/out-list-all-terms 2024-11-06 at 16.22.20@2x.png +0 -0
- pyegeria/commands/doc/glossary/images/out-list-terms-for-example 2024-11-06 at 16.40.12.png +0 -0
- pyegeria/commands/doc/glossary/images/out-list-terms-second 2024-11-06 at 16.45.13.png +0 -0
- pyegeria/commands/doc/glossary/images/out-pipx install pyegeria 2024-11-10 at 18.12.21.png +0 -0
- pyegeria/commands/doc/glossary/images/out-server-status-full 2024-11-10 at 18.25.14.png +0 -0
- pyegeria/commands/doc/glossary/images/out-servers-status 2024-11-10 at 18.15.42.png +0 -0
- pyegeria/commands/doc/glossary/images/out-upsert-import 2024-11-07 at 19.37.00.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-2024-11-10 at 18.26.29.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-create-glossary example 2024-11-05 at 20.34.24@2x.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-create-term 2024-11-06 at 20.46.35.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-delete-term 2024-11-07 at 03.51.57.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-display-terms-for-example 2024-11-06 at 20.56.49.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-export-example 2024-11-07 at 09.52.59.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-hey-egeria 2024-11-10 at 18.31.01.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-import-upsert-example 2024-11-07 at 10.08.37.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-list-terms-second 2024-11-06 at 16.46.34.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-load-archive.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-server-status-full 2024-11-10 at 19.14.36.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-show-glossaries 2024-11-07 at 20.00.05.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-show-glossary-terms 2024-11-05 at 19.37.53@2x.png +0 -0
- pyegeria/commands/doc/glossary/images/tui-upsert 2024-11-07 at 11.49.04.png +0 -0
- pyegeria/commands/doc/glossary/images/upsert-example.om-terms 2024-11-07 at 11.44.05.png +0 -0
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/README.md +0 -346
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/CleanShot 2024-11-18 at 21.32.03@2x.png +0 -0
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731421782704.png +0 -0
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731422134920.png +0 -0
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/hey_egeria 2024-11-12 at 20.38.43.png +0 -0
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/hey_egeria cat 2024-11-12 at 21.41.43.png +0 -0
- 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
- 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
- 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
- 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
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/short-cut commands 2024-11-12 at 22.22.13.png +0 -0
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-hey-egeria.png +0 -0
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-integration-status-paging.png +0 -0
- 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
- 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
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-show-server-status-full 2024-11-10.png +0 -0
- 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
- pyegeria/dr_egeria_state.py +0 -67
- pyegeria/md_processing/__init__.py +0 -51
- pyegeria/md_processing/commands/__init__.py +0 -3
- pyegeria/md_processing/commands/blueprint_commands.py +0 -307
- pyegeria/md_processing/commands/category_commands.py +0 -242
- pyegeria/md_processing/commands/glossary_commands.py +0 -225
- pyegeria/md_processing/commands/project_commands.py +0 -169
- pyegeria/md_processing/commands/term_commands.py +0 -524
- pyegeria/md_processing/utils/__init__.py +0 -3
- pyegeria/md_processing/utils/common_utils.py +0 -101
- pyegeria/md_processing/utils/display_utils.py +0 -53
- pyegeria/md_processing/utils/extraction_utils.py +0 -177
- pyegeria/md_processing/utils/validation_utils.py +0 -208
- pyegeria-5.3.9.5.dist-info/RECORD +0 -265
- pyegeria-5.3.9.5.dist-info/entry_points.txt +0 -98
- {pyegeria/commands → commands}/cat/README.md +0 -0
- {pyegeria/commands → commands}/cat/__init__.py +0 -0
- {pyegeria/commands → commands}/cat/exp_list_glossaries.py +0 -0
- {pyegeria/commands → commands}/cat/get_asset_graph.py +0 -0
- {pyegeria/commands → commands}/cat/get_collection.py +0 -0
- {pyegeria/commands → commands}/cat/get_project_dependencies.py +0 -0
- {pyegeria/commands → commands}/cat/get_project_structure.py +0 -0
- {pyegeria/commands → commands}/cat/get_tech_type_elements.py +0 -0
- {pyegeria/commands → commands}/cat/glossary_actions.py +0 -0
- {pyegeria/commands → commands}/cat/list_assets.py +0 -0
- {pyegeria/commands → commands}/cat/list_cert_types.py +0 -0
- {pyegeria/commands → commands}/cat/list_deployed_catalogs.py +0 -0
- {pyegeria/commands → commands}/cat/list_deployed_database_schemas.py +0 -0
- {pyegeria/commands → commands}/cat/list_deployed_databases.py +0 -0
- {pyegeria/commands → commands}/cat/list_deployed_servers.py +0 -0
- {pyegeria/commands → commands}/cat/list_projects.py +0 -0
- {pyegeria/commands → commands}/cat/list_tech_type_elements.py +0 -0
- {pyegeria/commands → commands}/cat/list_tech_types.py +0 -0
- {pyegeria/commands → commands}/cat/list_todos.py +0 -0
- {pyegeria/commands → commands}/cat/list_user_ids.py +0 -0
- {pyegeria/commands → commands}/cli/ops_config.py +0 -0
- {pyegeria/commands → commands}/cli/txt_custom_v2.tcss +0 -0
- {pyegeria/commands → commands}/my/README.md +0 -0
- {pyegeria/commands → commands}/my/__init__.py +0 -0
- {pyegeria/commands → commands}/my/list_my_profile.py +0 -0
- {pyegeria/commands → commands}/my/list_my_roles.py +0 -0
- {pyegeria/commands → commands}/my/monitor_my_todos.py +0 -0
- {pyegeria/commands → commands}/my/monitor_open_todos.py +0 -0
- {pyegeria/commands → commands}/my/todo_actions.py +0 -0
- {pyegeria/commands → commands}/ops/README.md +0 -0
- {pyegeria/commands → commands}/ops/__init__.py +0 -0
- {pyegeria/commands → commands}/ops/gov_server_actions.py +0 -0
- {pyegeria/commands → commands}/ops/list_archives.py +0 -0
- {pyegeria/commands → commands}/ops/list_catalog_targets.py +0 -0
- {pyegeria/commands → commands}/ops/load_archive.py +0 -0
- {pyegeria/commands → commands}/ops/monitor_asset_events.py +0 -0
- {pyegeria/commands → commands}/ops/monitor_engine_activity.py +0 -0
- {pyegeria/commands → commands}/ops/monitor_engine_activity_c.py +0 -0
- {pyegeria/commands → commands}/ops/monitor_gov_eng_status.py +0 -0
- {pyegeria/commands → commands}/ops/monitor_integ_daemon_status.py +0 -0
- {pyegeria/commands → commands}/ops/monitor_platform_status.py +0 -0
- {pyegeria/commands → commands}/ops/monitor_server_startup.py +0 -0
- {pyegeria/commands → commands}/ops/monitor_server_status.py +0 -0
- {pyegeria/commands → commands}/ops/orig_monitor_server_list.py +0 -0
- {pyegeria/commands → commands}/ops/orig_monitor_server_status.py +0 -0
- {pyegeria/commands → commands}/ops/refresh_integration_daemon.py +0 -0
- {pyegeria/commands → commands}/ops/restart_integration_daemon.py +0 -0
- {pyegeria/commands → commands}/ops/table_integ_daemon_status.py +0 -0
- {pyegeria/commands → commands}/ops/x_engine_actions.py +0 -0
- {pyegeria/commands → commands}/tech/README.md +0 -0
- {pyegeria/commands → commands}/tech/__init__.py +0 -0
- {pyegeria/commands → commands}/tech/get_element_info.py +0 -0
- {pyegeria/commands → commands}/tech/get_guid_info.py +0 -0
- {pyegeria/commands → commands}/tech/get_tech_details.py +0 -0
- {pyegeria/commands → commands}/tech/get_tech_type_template.py +0 -0
- {pyegeria/commands → commands}/tech/list_all_om_type_elements.py +0 -0
- {pyegeria/commands → commands}/tech/list_all_om_type_elements_x.py +0 -0
- {pyegeria/commands → commands}/tech/list_all_related_elements.py +0 -0
- {pyegeria/commands → commands}/tech/list_anchored_elements.py +0 -0
- {pyegeria/commands → commands}/tech/list_asset_types.py +0 -0
- {pyegeria/commands → commands}/tech/list_elements_by_classification_by_property_value.py +0 -0
- {pyegeria/commands → commands}/tech/list_elements_by_property_value.py +0 -0
- {pyegeria/commands → commands}/tech/list_elements_by_property_value_x.py +0 -0
- {pyegeria/commands → commands}/tech/list_elements_for_classification.py +0 -0
- {pyegeria/commands → commands}/tech/list_gov_action_processes.py +0 -0
- {pyegeria/commands → commands}/tech/list_registered_services.py +0 -0
- {pyegeria/commands → commands}/tech/list_related_elements_with_prop_value.py +0 -0
- {pyegeria/commands → commands}/tech/list_related_specification.py +0 -0
- {pyegeria/commands → commands}/tech/list_relationship_types.py +0 -0
- {pyegeria/commands → commands}/tech/list_relationships.py +0 -0
- {pyegeria/commands → commands}/tech/list_solution_blueprints.py +0 -0
- {pyegeria/commands → commands}/tech/list_solution_components.py +0 -0
- {pyegeria/commands → commands}/tech/list_solution_roles.py +0 -0
- {pyegeria/commands → commands}/tech/list_tech_templates.py +0 -0
- {pyegeria/commands → commands}/tech/list_valid_metadata_values.py +0 -0
- {pyegeria/commands → commands}/tech/table_tech_templates.py +0 -0
- {pyegeria/commands → commands}/tech/x_list_related_elements.py +0 -0
- {pyegeria-5.3.9.5.dist-info → pyegeria-5.3.9.7.dist-info}/LICENSE +0 -0
- {pyegeria-5.3.9.5.dist-info → pyegeria-5.3.9.7.dist-info}/WHEEL +0 -0
pyegeria/commands/README.md
DELETED
@@ -1,47 +0,0 @@
|
|
1
|
-
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
2
|
-
<!-- Copyright Contributors to the Egeria project. -->
|
3
|
-
|
4
|
-
The Commands in this directory provide a simple but useful command line interface for the Egeria environment. They
|
5
|
-
are built with the **Rich** python package and demonstrate the use of **pyegeria**. More detailed documentation can be
|
6
|
-
found in the `doc` folder.
|
7
|
-
|
8
|
-
The commands can either be invoked from one of the command line interfaces or executed directly as python scripts.
|
9
|
-
To invoke the commands directly, install them with pipx by invoking:
|
10
|
-
|
11
|
-
`pipx install pyegeria`
|
12
|
-
|
13
|
-
Some of the widgets are "live" - that is running continuously until ctrl-c is issued to interrupt it. Other widgets are
|
14
|
-
**paged** to allow you to page through long lists of content. Paged interfaces have a similar behaviour to the unix
|
15
|
-
`more` command - so, for example you type `q` to quit.
|
16
|
-
|
17
|
-
As the number of widgets has grown, they have been organized by role into different sub-directories:
|
18
|
-
|
19
|
-
* cat (catalog_user) - for users of the Egeria environment
|
20
|
-
* cli - command line interfaces to simplify finding and using the commands
|
21
|
-
* my - for visualizing work and individual items
|
22
|
-
* ops - for configuring and operating Egeria
|
23
|
-
* tech - for technical users to configure and use Egeria
|
24
|
-
|
25
|
-
The command line interfaces (CLIs) can be invoked with:
|
26
|
-
|
27
|
-
hey_egeria - provides access to all commands
|
28
|
-
hey_egeria_cat - access for commands used by catalog users
|
29
|
-
hey_egeria_my - access to personal information commands for all users
|
30
|
-
hey_egeria_ops - access to operations commands
|
31
|
-
hey_egeria_tech - access to commands for technical users
|
32
|
-
|
33
|
-
Each of these CLIs have a textual user interface (TUI) that provides a forms based approach
|
34
|
-
to utilizing each command. You invoke the TUI by adding `tui` to the cli command. For instance:
|
35
|
-
|
36
|
-
`hey_egeria_cat tui`
|
37
|
-
|
38
|
-
To execute a command from the TUI type ctrl-R.
|
39
|
-
|
40
|
-
|
41
|
-
To upgrade the CLI commands you can type:
|
42
|
-
|
43
|
-
`pipx upgrade pyegeria`
|
44
|
-
|
45
|
-
----
|
46
|
-
License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
|
47
|
-
Copyright Contributors to the Egeria project.
|
pyegeria/commands/__init__.py
DELETED
@@ -1,30 +0,0 @@
|
|
1
|
-
"""
|
2
|
-
SPDX-License-Identifier: Apache-2.0
|
3
|
-
Copyright Contributors to the ODPi Egeria project.
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
pyegeria commands available also from python.
|
8
|
-
"""
|
9
|
-
|
10
|
-
from .cat.list_deployed_catalogs import list_deployed_catalogs
|
11
|
-
from .cat.list_deployed_database_schemas import list_deployed_database_schemas
|
12
|
-
from .cat.list_deployed_databases import list_deployed_databases
|
13
|
-
from .cat.list_glossaries import display_glossaries
|
14
|
-
from .cat.list_terms import display_glossary_terms
|
15
|
-
from .ops.list_catalog_targets import display_catalog_targets
|
16
|
-
from .ops.monitor_engine_activity_c import display_engine_activity_c
|
17
|
-
from .ops.monitor_gov_eng_status import display_gov_eng_status
|
18
|
-
from .ops.monitor_integ_daemon_status import display_integration_daemon_status
|
19
|
-
from .ops.table_integ_daemon_status import (
|
20
|
-
display_integration_daemon_status as table_integ_daemon_status,
|
21
|
-
)
|
22
|
-
from .tech.list_elements_by_property_value import EGERIA_WIDTH
|
23
|
-
|
24
|
-
|
25
|
-
def list_integration_daemon_status(
|
26
|
-
search_list: str, width: int = EGERIA_WIDTH, sort: bool = True
|
27
|
-
):
|
28
|
-
table_integ_daemon_status(
|
29
|
-
search_list=search_list, paging=True, width=width, sort=sort
|
30
|
-
)
|
@@ -1,341 +0,0 @@
|
|
1
|
-
{
|
2
|
-
"cells": [
|
3
|
-
{
|
4
|
-
"cell_type": "markdown",
|
5
|
-
"id": "f211c1736f87555",
|
6
|
-
"metadata": {},
|
7
|
-
"source": [
|
8
|
-
"# This notebook contains experimental Freddie commands\n",
|
9
|
-
"## Lets see if this is parsed\n",
|
10
|
-
"meow"
|
11
|
-
]
|
12
|
-
},
|
13
|
-
{
|
14
|
-
"metadata": {
|
15
|
-
"ExecuteTime": {
|
16
|
-
"end_time": "2025-03-06T01:43:38.278089Z",
|
17
|
-
"start_time": "2025-03-06T01:43:38.276538Z"
|
18
|
-
}
|
19
|
-
},
|
20
|
-
"cell_type": "code",
|
21
|
-
"source": "",
|
22
|
-
"id": "2716f0b6c001136a",
|
23
|
-
"outputs": [],
|
24
|
-
"execution_count": null
|
25
|
-
},
|
26
|
-
{
|
27
|
-
"cell_type": "markdown",
|
28
|
-
"id": "3b321563-4977-496a-963b-9b9dd75de968",
|
29
|
-
"metadata": {},
|
30
|
-
"source": [
|
31
|
-
"# Create Glossary\n",
|
32
|
-
"## Glossary Name\n",
|
33
|
-
"\n",
|
34
|
-
"Egeria-Markdown\n",
|
35
|
-
"\n",
|
36
|
-
"## Language\n",
|
37
|
-
"English\n",
|
38
|
-
"\n",
|
39
|
-
"## Description\n",
|
40
|
-
"\n",
|
41
|
-
"Glossary to describe the vocabulary of Freddie - an Egeria Markdown language to support the exchange of metadata in a Markdown form.\n",
|
42
|
-
"Freddie allows users to input metadata using any text entry system that supports the entry of standard Markdown characters and through post-processing\n",
|
43
|
-
"commands, validates the Egeria content and allows the requests to be sent to Egeria. This is an update\n",
|
44
|
-
"\n",
|
45
|
-
"\n",
|
46
|
-
"## Usage\n",
|
47
|
-
"1) (optional) load an example or template for the type of object from Egeria.\n",
|
48
|
-
"2) Create a new document (perhaps from the template) and edit it, adding in the content with the Freddie controlled Markdown language.\n",
|
49
|
-
"3) Process the document to validate and display it before you submit it, Validation may annotate your document with recommendations and potential issues.\n",
|
50
|
-
"4) Submit the document to Egeria using the Freddie_sings command.\n",
|
51
|
-
"5) anything?\n",
|
52
|
-
"\n",
|
53
|
-
"## <Qualified Name>\n",
|
54
|
-
"\n",
|
55
|
-
"\n",
|
56
|
-
"## <GUID>\n",
|
57
|
-
"\n"
|
58
|
-
]
|
59
|
-
},
|
60
|
-
{
|
61
|
-
"cell_type": "code",
|
62
|
-
"id": "a7295df2-5afb-46ba-889a-94881d883678",
|
63
|
-
"metadata": {
|
64
|
-
"execution": {
|
65
|
-
"iopub.execute_input": "2025-02-27T15:23:58.820592Z",
|
66
|
-
"iopub.status.busy": "2025-02-27T15:23:58.820416Z",
|
67
|
-
"iopub.status.idle": "2025-02-27T15:24:00.802861Z",
|
68
|
-
"shell.execute_reply": "2025-02-27T15:24:00.802425Z",
|
69
|
-
"shell.execute_reply.started": "2025-02-27T15:23:58.820583Z"
|
70
|
-
},
|
71
|
-
"ExecuteTime": {
|
72
|
-
"end_time": "2025-03-06T01:43:44.148760Z",
|
73
|
-
"start_time": "2025-03-06T01:43:42.291143Z"
|
74
|
-
}
|
75
|
-
},
|
76
|
-
"source": [
|
77
|
-
"%pip install jupyter-notebook-parser\n",
|
78
|
-
"%pip install marko"
|
79
|
-
],
|
80
|
-
"outputs": [
|
81
|
-
{
|
82
|
-
"name": "stdout",
|
83
|
-
"output_type": "stream",
|
84
|
-
"text": [
|
85
|
-
"Requirement already satisfied: jupyter-notebook-parser in /Users/dwolfson/Library/Caches/pypoetry/virtualenvs/pyegeria-EE3A6T0J-py3.12/lib/python3.12/site-packages (0.1.4)\r\n",
|
86
|
-
"Note: you may need to restart the kernel to use updated packages.\n",
|
87
|
-
"Collecting marko\r\n",
|
88
|
-
" Downloading marko-2.1.2-py3-none-any.whl.metadata (4.5 kB)\r\n",
|
89
|
-
"Downloading marko-2.1.2-py3-none-any.whl (42 kB)\r\n",
|
90
|
-
"Installing collected packages: marko\r\n",
|
91
|
-
"Successfully installed marko-2.1.2\r\n",
|
92
|
-
"Note: you may need to restart the kernel to use updated packages.\n"
|
93
|
-
]
|
94
|
-
}
|
95
|
-
],
|
96
|
-
"execution_count": 1
|
97
|
-
},
|
98
|
-
{
|
99
|
-
"cell_type": "code",
|
100
|
-
"id": "d02383df-f617-48f7-be54-e930b6275a7e",
|
101
|
-
"metadata": {
|
102
|
-
"execution": {
|
103
|
-
"iopub.execute_input": "2025-02-27T15:25:33.155175Z",
|
104
|
-
"iopub.status.busy": "2025-02-27T15:25:33.154695Z",
|
105
|
-
"iopub.status.idle": "2025-02-27T15:25:33.162801Z",
|
106
|
-
"shell.execute_reply": "2025-02-27T15:25:33.162362Z",
|
107
|
-
"shell.execute_reply.started": "2025-02-27T15:25:33.155158Z"
|
108
|
-
},
|
109
|
-
"ExecuteTime": {
|
110
|
-
"end_time": "2025-03-06T01:44:09.244223Z",
|
111
|
-
"start_time": "2025-03-06T01:44:09.242117Z"
|
112
|
-
}
|
113
|
-
},
|
114
|
-
"source": [
|
115
|
-
"import json\n",
|
116
|
-
"import marko\n",
|
117
|
-
"from jupyter_notebook_parser import JupyterNotebookParser"
|
118
|
-
],
|
119
|
-
"outputs": [],
|
120
|
-
"execution_count": 3
|
121
|
-
},
|
122
|
-
{
|
123
|
-
"cell_type": "code",
|
124
|
-
"id": "b5560fcd-afe4-4133-8204-8f2535feb9b6",
|
125
|
-
"metadata": {
|
126
|
-
"execution": {
|
127
|
-
"iopub.execute_input": "2025-02-27T15:25:34.354443Z",
|
128
|
-
"iopub.status.busy": "2025-02-27T15:25:34.354300Z",
|
129
|
-
"iopub.status.idle": "2025-02-27T15:25:34.358702Z",
|
130
|
-
"shell.execute_reply": "2025-02-27T15:25:34.358236Z",
|
131
|
-
"shell.execute_reply.started": "2025-02-27T15:25:34.354435Z"
|
132
|
-
},
|
133
|
-
"ExecuteTime": {
|
134
|
-
"end_time": "2025-03-06T01:44:10.183573Z",
|
135
|
-
"start_time": "2025-03-06T01:44:10.180327Z"
|
136
|
-
}
|
137
|
-
},
|
138
|
-
"source": [
|
139
|
-
"parsed = JupyterNotebookParser('glossary_creation_experiment.ipynb')\n",
|
140
|
-
"\n",
|
141
|
-
"parsed.get_all_cells() # returns List[Dict], each Dict is a notebook cell\n",
|
142
|
-
"\n",
|
143
|
-
"cells = parsed.get_markdown_cells() # returns List[Dict], each Dict is a markdown cel\n",
|
144
|
-
"indices = parsed.get_markdown_cell_indices() # returns List[int], each is a markdown cell's index\n",
|
145
|
-
"cell_sources = parsed.get_markdown_cell_sources() # returns List[str], each is a markdown cell's text\n",
|
146
|
-
"print(json.dumps(cell_sources, indent = 4))"
|
147
|
-
],
|
148
|
-
"outputs": [
|
149
|
-
{
|
150
|
-
"name": "stdout",
|
151
|
-
"output_type": "stream",
|
152
|
-
"text": [
|
153
|
-
"[\n",
|
154
|
-
" \"# This notebook contains experimental Freddie commands\\n## Lets see if this is parsed\\nmeow\",\n",
|
155
|
-
" \"# Update Glossary\\n## Glossary Name\\n\\nEgeria-Markdown\\n\\n## Language\\nEnglish\\n\\n## Description\\n\\nGlossary to describe the vocabulary of Freddie - an Egeria Markdown language to support the exchange of metadata in a Markdown form.\\nFreddie allows users to input metadata using any text entry system that supports the entry of standard Markdown characters and through post-processing\\ncommands, validates the Egeria content and allows the requests to be sent to Egeria. This is an update\\n\\n\\n## Usage\\n1) (optional) load an example or template for the type of object from Egeria.\\n2) Create a new document (perhaps from the template) and edit it, adding in the content with the Freddie controlled Markdown language.\\n3) Process the document to validate and display it before you submit it, Validation may annotate your document with recommendations and potential issues.\\n4) Submit the document to Egeria using the Freddie_sings command.\\n5) anything?\\n\\n## <Qualified Name>\\n\\n## <GUID>\\n\\n\",\n",
|
156
|
-
" \"# Create Term\\n\\n## Glossary Name\\n\\nEgeria-Markdown\\n\\n## Term Name\\n\\nCommand\\n\\n## Summary\\n\\nCommands are how a user of the Freddie markdown language requests an action.\\n## Description\\n\\nCommands are how a user can request Egeria to take an action such as Create or Update an Egeria element. Freddie provides\\na limited (but growing) set of commands. Freddie commands align with the pyegeria 'hey-egeria' command line interface.\\n\\n## Abbreviation\\n\\n## Examples\\nCreate Glossary or\\nUpdate Glossary or\\nCreate Term or\\nUpdate Term\\n## Usage\\n\\nCommands are used in the Freddie Egeria markdown language.\\n## Version\\n0.2\\n## Status\\nDRAFT\\n\\n## Qualified Name\\n\\nGlossaryTerm:Command:20250301101716\\n\\n\",\n",
|
157
|
-
" \"# Create Term\\n\\n## Glossary Name\\n\\nEgeria-Markdown\\n\\n## Term Name\\n\\nSource\\n\\n## Summary\\n\\nSource of the markdown content.\\n## Description\\n\\nSource of the markdown content - could be jupter or plain markdown file.\\n\\n## Abbreviation\\n\\n## Examples\\n\\n## Usage\\n\\n\\n## Version\\n0.1\\n## Status\\nDRAFT\\n\\n## Update Description\\n\\n\",\n",
|
158
|
-
" \"# Create Glossary\\n## Glossary Name\\n\\nAnother Test\\n\\n## Language\\nEnglish\\n\\n## Description\\n\\nAnother quick test\\n\\n## Usage\\nAlternate sundays\\n\\n## <Qualified Name>\\n\\n## <GUID>\"\n",
|
159
|
-
"]\n"
|
160
|
-
]
|
161
|
-
}
|
162
|
-
],
|
163
|
-
"execution_count": 4
|
164
|
-
},
|
165
|
-
{
|
166
|
-
"cell_type": "code",
|
167
|
-
"id": "79dffa96-7e2a-40e3-a0d7-ba363d87b70c",
|
168
|
-
"metadata": {
|
169
|
-
"execution": {
|
170
|
-
"iopub.execute_input": "2025-02-27T15:42:47.354237Z",
|
171
|
-
"iopub.status.busy": "2025-02-27T15:42:47.353238Z",
|
172
|
-
"iopub.status.idle": "2025-02-27T15:42:47.360634Z",
|
173
|
-
"shell.execute_reply": "2025-02-27T15:42:47.360090Z",
|
174
|
-
"shell.execute_reply.started": "2025-02-27T15:42:47.354193Z"
|
175
|
-
},
|
176
|
-
"ExecuteTime": {
|
177
|
-
"end_time": "2025-03-06T01:44:13.510939Z",
|
178
|
-
"start_time": "2025-03-06T01:44:13.507934Z"
|
179
|
-
}
|
180
|
-
},
|
181
|
-
"source": [
|
182
|
-
"parsed_markdown = marko.parse(cell_sources[0])\n",
|
183
|
-
"print(type(parsed_markdown))"
|
184
|
-
],
|
185
|
-
"outputs": [
|
186
|
-
{
|
187
|
-
"name": "stdout",
|
188
|
-
"output_type": "stream",
|
189
|
-
"text": [
|
190
|
-
"<class 'marko.block.Document'>\n"
|
191
|
-
]
|
192
|
-
}
|
193
|
-
],
|
194
|
-
"execution_count": 5
|
195
|
-
},
|
196
|
-
{
|
197
|
-
"cell_type": "code",
|
198
|
-
"execution_count": null,
|
199
|
-
"id": "e967897d83588f86",
|
200
|
-
"metadata": {},
|
201
|
-
"outputs": [],
|
202
|
-
"source": []
|
203
|
-
},
|
204
|
-
{
|
205
|
-
"metadata": {},
|
206
|
-
"cell_type": "markdown",
|
207
|
-
"source": [
|
208
|
-
"# Create Term\n",
|
209
|
-
"\n",
|
210
|
-
"## Glossary Name\n",
|
211
|
-
"\n",
|
212
|
-
"Egeria-Markdown\n",
|
213
|
-
"\n",
|
214
|
-
"## Term Name\n",
|
215
|
-
"\n",
|
216
|
-
"Command\n",
|
217
|
-
"\n",
|
218
|
-
"## Summary\n",
|
219
|
-
"\n",
|
220
|
-
"Commands are how a user of the Freddie markdown language requests an action.\n",
|
221
|
-
"## Description\n",
|
222
|
-
"\n",
|
223
|
-
"Commands are how a user can request Egeria to take an action such as Create or Update an Egeria element. Freddie provides\n",
|
224
|
-
"a limited (but growing) set of commands. Freddie commands align with the pyegeria 'hey-egeria' command line interface.\n",
|
225
|
-
"\n",
|
226
|
-
"## Abbreviation\n",
|
227
|
-
"\n",
|
228
|
-
"## Examples\n",
|
229
|
-
"Create Glossary or\n",
|
230
|
-
"Update Glossary or\n",
|
231
|
-
"Create Term or\n",
|
232
|
-
"Update Term\n",
|
233
|
-
"## Usage\n",
|
234
|
-
"\n",
|
235
|
-
"Commands are used in the Freddie Egeria markdown language.\n",
|
236
|
-
"## Version\n",
|
237
|
-
"0.2\n",
|
238
|
-
"## Status\n",
|
239
|
-
"DRAFT\n",
|
240
|
-
"\n",
|
241
|
-
"## Qualified Name\n",
|
242
|
-
"\n",
|
243
|
-
"GlossaryTerm:Command:20250301101716\n",
|
244
|
-
"\n"
|
245
|
-
],
|
246
|
-
"id": "12bee9ed12b3762a"
|
247
|
-
},
|
248
|
-
{
|
249
|
-
"metadata": {},
|
250
|
-
"cell_type": "markdown",
|
251
|
-
"source": [
|
252
|
-
"# Create Term\n",
|
253
|
-
"\n",
|
254
|
-
"## Glossary Name\n",
|
255
|
-
"\n",
|
256
|
-
"Egeria-Markdown\n",
|
257
|
-
"\n",
|
258
|
-
"## Term Name\n",
|
259
|
-
"\n",
|
260
|
-
"Source\n",
|
261
|
-
"\n",
|
262
|
-
"## Summary\n",
|
263
|
-
"\n",
|
264
|
-
"Source of the markdown content.\n",
|
265
|
-
"## Description\n",
|
266
|
-
"\n",
|
267
|
-
"Source of the markdown content - could be jupter or plain markdown file.\n",
|
268
|
-
"\n",
|
269
|
-
"## Abbreviation\n",
|
270
|
-
"\n",
|
271
|
-
"## Examples\n",
|
272
|
-
"\n",
|
273
|
-
"## Usage\n",
|
274
|
-
"\n",
|
275
|
-
"\n",
|
276
|
-
"## Version\n",
|
277
|
-
"0.1\n",
|
278
|
-
"## Status\n",
|
279
|
-
"DRAFT\n",
|
280
|
-
"\n",
|
281
|
-
"## Update Description\n",
|
282
|
-
"\n"
|
283
|
-
],
|
284
|
-
"id": "d2eafeb21facfe57"
|
285
|
-
},
|
286
|
-
{
|
287
|
-
"cell_type": "markdown",
|
288
|
-
"id": "ed29f0e5d46a7c20",
|
289
|
-
"metadata": {},
|
290
|
-
"source": [
|
291
|
-
"# Update Glossary\n",
|
292
|
-
"## Glossary Name\n",
|
293
|
-
"\n",
|
294
|
-
"Another Test\n",
|
295
|
-
"\n",
|
296
|
-
"## Language\n",
|
297
|
-
"English\n",
|
298
|
-
"\n",
|
299
|
-
"## Description\n",
|
300
|
-
"\n",
|
301
|
-
"Another quick test - more description\n",
|
302
|
-
"\n",
|
303
|
-
"## Usage\n",
|
304
|
-
"Alternate sundays\n",
|
305
|
-
"\n",
|
306
|
-
"## <Qualified Name>\n",
|
307
|
-
"\n",
|
308
|
-
"## <GUID>"
|
309
|
-
]
|
310
|
-
},
|
311
|
-
{
|
312
|
-
"cell_type": "code",
|
313
|
-
"execution_count": null,
|
314
|
-
"id": "e36a5074b9a94c1a",
|
315
|
-
"metadata": {},
|
316
|
-
"outputs": [],
|
317
|
-
"source": []
|
318
|
-
}
|
319
|
-
],
|
320
|
-
"metadata": {
|
321
|
-
"kernelspec": {
|
322
|
-
"display_name": "Python 3 (ipykernel)",
|
323
|
-
"language": "python",
|
324
|
-
"name": "python3"
|
325
|
-
},
|
326
|
-
"language_info": {
|
327
|
-
"codemirror_mode": {
|
328
|
-
"name": "ipython",
|
329
|
-
"version": 3
|
330
|
-
},
|
331
|
-
"file_extension": ".py",
|
332
|
-
"mimetype": "text/x-python",
|
333
|
-
"name": "python",
|
334
|
-
"nbconvert_exporter": "python",
|
335
|
-
"pygments_lexer": "ipython3",
|
336
|
-
"version": "3.12.9"
|
337
|
-
}
|
338
|
-
},
|
339
|
-
"nbformat": 4,
|
340
|
-
"nbformat_minor": 5
|
341
|
-
}
|
pyegeria/commands/doc/README.md
DELETED
@@ -1,145 +0,0 @@
|
|
1
|
-
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
2
|
-
<!-- Copyright Contributors to the Egeria project. -->
|
3
|
-
|
4
|
-
# Overview
|
5
|
-
|
6
|
-
**hey_egeria** is a friendly, easy to use, command line interface (CLI) for Egeria with both a scriptable component and a textual user
|
7
|
-
interface to guide
|
8
|
-
users through the different commands and options. This interface is being actively maintained and enhanced. There are
|
9
|
-
currently about 70 commands in the interface and new ones are added based on perceived need and community feedback.
|
10
|
-
|
11
|
-
The CLI is written in python using the [click](https://click.palletsprojects.com/en/stable/) package
|
12
|
-
with [trogon](https://github.com/Textualize/trogon)
|
13
|
-
providing the textual user interface. The commands are written using [pyegeria](https://github.com/odpi/egeria-python)
|
14
|
-
or
|
15
|
-
https://pypi.org/project/pyegeria/. Commands are also available standalone. Simple standalone installation instructions
|
16
|
-
are
|
17
|
-
documented at [pyegeria](https://egeria-project.org/concepts/pyegeria). pyegeria and hey_egeria are pre-installed within
|
18
|
-
the **Egeria Workspaces** environment - [Egeria Workspaces](https://github.com/odpi/egeria-workspaces).
|
19
|
-
|
20
|
-
# Command Line Interfaces
|
21
|
-
## Commands
|
22
|
-
A command line interface provides a simple language for users to invoke commands. In the case of **hey_egeria**, once it
|
23
|
-
is installed, you can
|
24
|
-
start simply by typing `hey_egeria` on the command line and it will provide a list of options and commands that you can
|
25
|
-
use to interact with it. Commands are often arranged hierarchically - so, for instance if we type just `hey_egeria`, the
|
26
|
-
command options presented to us are:
|
27
|
-
|
28
|
-
```aiignore
|
29
|
-
Commands:
|
30
|
-
cat Commands for all users
|
31
|
-
my Work with my information
|
32
|
-
ops Commands to understand and manage operations
|
33
|
-
tech Commands for tech Users
|
34
|
-
tui Open Textual TUI
|
35
|
-
```
|
36
|
-
|
37
|
-
"cat", "my", "ops", and "tech" represent groups of commands oriented towards particular roles. If a user wants to only
|
38
|
-
use commands from a single role they can use a variant of hey_egeria that follows the pattern `hey_egeria_xxx`. So,
|
39
|
-
for example, `hey_egeria_cat` is the entry point for general catalog users.
|
40
|
-
|
41
|
-
Within each of these categories, commands are further split between **show** and **tell**. **Show** commands display
|
42
|
-
information to the user on the terminal and **tell** commands instruct Egeria to take some action. Commands may be further
|
43
|
-
sub-divided into topics.
|
44
|
-
|
45
|
-
So for example the command to display the status of the Egeria Platform is:
|
46
|
-
|
47
|
-
`hey_egeria ops show platforms status`
|
48
|
-
|
49
|
-
And the command to list all glossaries is:
|
50
|
-
|
51
|
-
`hey_egeria cat show glossary glossaries`
|
52
|
-
|
53
|
-
## Options & Parameters
|
54
|
-
|
55
|
-
Each command has a number of optional, and often some mandatory parameters. There are really two groups of options.
|
56
|
-
* General options - that are present for every command. Sensible defaults based on environment variables are set for each.
|
57
|
-
* Command specific optons & parameters
|
58
|
-
|
59
|
-
# Command Reference
|
60
|
-
|
61
|
-
| Command | Purpose | Cat | My | Ops | Tech | python |
|
62
|
-
|------------------------------------|--------------------------------------------------------------|-----|----|-----|------|--------|
|
63
|
-
| change_todo_status | Update a ToDo item status | | ✓ | | | |
|
64
|
-
| create_glossary | Create a new glossary | ✓ | | | | |
|
65
|
-
| create_term | Create a new term | ✓ | | | | |
|
66
|
-
| create_todo | Create a new ToDo item | | ✓ | | | |
|
67
|
-
| delete_glossary | Delete the specified glossary | ✓ | | | | |
|
68
|
-
| delete_term | Delete the specified term | ✓ | | | | |
|
69
|
-
| export_terms_to_file | Export the specified glossary | ✓ | | | | |
|
70
|
-
| get_asset_graph | Display a tree graph of information about an asset | ✓ | | | | |
|
71
|
-
| get_collection | Display a information about a collection | ✓ | | | | |
|
72
|
-
| get_element_graph | Return a table of elements and matching elements | | | | ✓ | |
|
73
|
-
| get_element_info | Display elements of a specific Open Metadata Type | | | | ✓ | |
|
74
|
-
| get_guid_info | Display information about GUID specified object | | | | ✓ | |
|
75
|
-
| get_project_dependencies | Show the dependencies of a project from a root | ✓ | | | | |
|
76
|
-
| get_project_structure | Show the organization structure of a project | ✓ | | | | |
|
77
|
-
| get_tech_details | Show details about a particular technology type | | | | ✓ | |
|
78
|
-
| get_tech_type_elements | Display elements of a specific technology type | ✓ | | | | |
|
79
|
-
| get_tech_type_template | Display the templates defined for a technology type | ✓ | | | | |
|
80
|
-
| hey_egeria | Textual User Interface for the pyegeria commands | | | | | |
|
81
|
-
| hey_egeria_cat | Textual User Interface for catalog use | | | | | |
|
82
|
-
| hey_egeria_my | Textual User Interface for personal use | | | | | |
|
83
|
-
| hey_egeria_ops | Textual User Interface for operations use | | | | | |
|
84
|
-
| hey_egeria_tech | Textual User Interface for technical use | | | | | |
|
85
|
-
| list_archives | Display the available archives known to Egeria | ✓ | | | | |
|
86
|
-
| list_asset_types | List the types of assets known to Egeria | | | | ✓ | |
|
87
|
-
| list_assets | Find and display assets in a domain | ✓ | | | | |
|
88
|
-
| list_catalog_targets | List the catalog target details for a connection | | | ✓ | | ✓ |
|
89
|
-
| list_cert_types | List certification types | ✓ | | | | |
|
90
|
-
| list_collections | List collections | ✓ | | | | |
|
91
|
-
| list_deployed_catalogs | List deployed catalogs | ✓ | | | | ✓ |
|
92
|
-
| list_deployed_databases | List deployed databases | ✓ | | | | ✓ |
|
93
|
-
| list_deployed_schemas | List deployed schemas | ✓ | | | | ✓ |
|
94
|
-
| list_deployed_servers | List deployed servers | ✓ | | | | |
|
95
|
-
| list_elements | Display table of Elements of an Open Metadata type | | | | ✓ | |
|
96
|
-
| list_elements_for_classification | List the elements of a classification | | | | ✓ | |
|
97
|
-
| list_engine_activity | List engine activity | | | ✓ | | |
|
98
|
-
| list_engine_activity_compressed | Compressed view of engine activity | | | ✓ | | ✓ |
|
99
|
-
| list_glossaries | List glossaries | ✓ | | | | ✓ |
|
100
|
-
| list_gov_action_processes | List governance action processes | | | | ✓ | |
|
101
|
-
| list_gov_eng_status | List the status of the governance engines | | | ✓ | | ✓ |
|
102
|
-
| list_integ_daemon_status | List status of an integration daemon server | | | ✓ | | ✓ |
|
103
|
-
| list_my_profile | List the details of the current user profile | | ✓ | | | |
|
104
|
-
| list_my_roles | List the roles of the current user | | ✓ | | | |
|
105
|
-
| list_projects | List projects filtered by search string | ✓ | | | | |
|
106
|
-
| list_registered_services | List all registered Egeria services | | | | ✓ | |
|
107
|
-
| list_related_elements | List elements related to a specific element | | | | ✓ | |
|
108
|
-
| list_related_specification | List details of related elements | | | | ✓ | |
|
109
|
-
| list_relationship_types | List types of relationships and their attributes | | | | ✓ | |
|
110
|
-
| list_relationships | List relationships for elements of a given type | ✓ | | | | |
|
111
|
-
| list_tech_templates | List templates for technology types | | | | ✓ | |
|
112
|
-
| list_tech_types | List technology types | ✓ | | | | |
|
113
|
-
| list_terms | List glossary terms | ✓ | | | | ✓ |
|
114
|
-
| list_todos | List to-do actions | ✓ | | | | |
|
115
|
-
| list_user_ids | Display table of known user ids | ✓ | | | | |
|
116
|
-
| list_valid_metadata_values | List valid metadata (reference) values | | | | ✓ | |
|
117
|
-
| load_archive | Load an archive/content-pack into Egeria | | | ✓ | | |
|
118
|
-
| load_archive_tui | Load an archive/content-pack into Egeria | | | ✓ | | |
|
119
|
-
| load_terms_from_file | Import glossary terms from a CSV file | ✓ | | | | |
|
120
|
-
| mark_todo_complete | Mark a to-do item as complete | | ✓ | | | |
|
121
|
-
| monitor_asset_events | Monitor asset events | | | ✓ | | |
|
122
|
-
| monitor_coco_status | Monitor status of Coco Sample servers | | | ✓ | | |
|
123
|
-
| monitor_engine_activity | Monitor engine activity | | | ✓ | | |
|
124
|
-
| monitor_engine_activity_compressed | Monitor engine activity | | | ✓ | | |
|
125
|
-
| monitor_gov_eng_status | Monitor status of an engine-host OMAG server | | | ✓ | | |
|
126
|
-
| monitor_integ_daemon_status | Monitor status of an integration daemon OMAG server | | | ✓ | | |
|
127
|
-
| monitor_my_todos | Monitor to-do items assigned to me | | ✓ | | | |
|
128
|
-
| monitor_open_todos | Monitor open to-do items | | ✓ | | | |
|
129
|
-
| monitor_platform_status | Monitor the status of all platforms | | | ✓ | | |
|
130
|
-
| monitor_server_list | List status of all servers using the RuntimeManager | | | ✓ | | |
|
131
|
-
| monitor_server_startup | Monitor the status of all servers using access services | | | ✓ | | |
|
132
|
-
| monitor_server_status | Monitor the status of all servers using the RuntimeManager | | | ✓ | | |
|
133
|
-
| reassign_todo | Reassign a todo item to a new actor | | ✓ | | | |
|
134
|
-
| refresh_gov_eng_config | Refresh the governance engines on an engine host | | | ✓ | | |
|
135
|
-
| refresh_integration_daemon | Refresh one or all integration connectors | | | ✓ | | |
|
136
|
-
| restart_integration_daemon | Restart and integration daemon | | | ✓ | | |
|
137
|
-
| start_daemon | Start or restart an OMAG server from its known configuration | | | ✓ | | |
|
138
|
-
| stop_daemon | Stop an OMAG server daemon | | | ✓ | | |
|
139
|
-
|
140
|
-
|
141
|
-
# Visual Command Reference
|
142
|
-
A visual command reference of all the `hey_egeria` **show** commands can be found [Visual Command Reference](https://github.com/odpi/egeria-python/tree/main/pyegeria/commands/doc/Visual%20Command%20Reference)
|
143
|
-
----
|
144
|
-
License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
|
145
|
-
Copyright Contributors to the Egeria project.
|