pyegeria 1.5.1.1.55__py3-none-any.whl → 1.5.1.1.57__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/cli/egeria.py +9 -15
- pyegeria/commands/cli/egeria_cat.py +1 -14
- pyegeria/commands/cli/egeria_my.py +0 -13
- pyegeria/commands/cli/egeria_ops.py +0 -13
- pyegeria/commands/cli/egeria_tech.py +0 -13
- pyegeria/commands/cli/ops_config.py +18 -9
- pyegeria/commands/doc/glossary/images/CleanShot 2024-11-12 out-integ-status-live 2024-11-12 at 16.44.12at 16.44.12@2x.png +0 -0
- pyegeria/commands/doc/glossary/images/hey_egeria 2024-11-12 at 20.38.43.png +0 -0
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/hey_egeria: overview.md +140 -6
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/.DS_Store +0 -0
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/CleanShot 2024-11-12 at 20.38.43@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/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/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-status-paging 2024-11-12 at 16.26.14@2x.png +0 -0
- pyegeria/commands/ops/load_archive.py +0 -1
- pyegeria/commands/ops/monitor_server_status.py +3 -3
- {pyegeria-1.5.1.1.55.dist-info → pyegeria-1.5.1.1.57.dist-info}/METADATA +1 -1
- {pyegeria-1.5.1.1.55.dist-info → pyegeria-1.5.1.1.57.dist-info}/RECORD +25 -15
- pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-hey-egeria 2024-11-10 at 18.31.01@2x.png +0 -0
- {pyegeria-1.5.1.1.55.dist-info → pyegeria-1.5.1.1.57.dist-info}/LICENSE +0 -0
- {pyegeria-1.5.1.1.55.dist-info → pyegeria-1.5.1.1.57.dist-info}/WHEEL +0 -0
- {pyegeria-1.5.1.1.55.dist-info → pyegeria-1.5.1.1.57.dist-info}/entry_points.txt +0 -0
pyegeria/commands/cli/egeria.py
CHANGED
@@ -178,13 +178,13 @@ from pyegeria.commands.tech.list_gov_action_processes import display_gov_process
|
|
178
178
|
help="Egeria user password",
|
179
179
|
)
|
180
180
|
@click.option("--timeout", default=60, help="Number of seconds to wait")
|
181
|
-
@click.option("--verbose", is_flag=True, default=False, help="Enable verbose mode")
|
182
|
-
@click.option(
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
)
|
181
|
+
# @click.option("--verbose", is_flag=True, default=False, help="Enable verbose mode")
|
182
|
+
# @click.option(
|
183
|
+
# "--paging",
|
184
|
+
# is_flag=True,
|
185
|
+
# default=False,
|
186
|
+
# help="Enable paging snapshots vs live updates",
|
187
|
+
# )
|
188
188
|
@click.option(
|
189
189
|
"--jupyter",
|
190
190
|
is_flag=True,
|
@@ -214,8 +214,6 @@ def cli(
|
|
214
214
|
userid,
|
215
215
|
password,
|
216
216
|
timeout,
|
217
|
-
paging,
|
218
|
-
verbose,
|
219
217
|
jupyter,
|
220
218
|
width,
|
221
219
|
):
|
@@ -234,15 +232,11 @@ def cli(
|
|
234
232
|
userid,
|
235
233
|
password,
|
236
234
|
timeout,
|
237
|
-
paging,
|
238
|
-
verbose,
|
239
235
|
jupyter,
|
240
236
|
width,
|
241
237
|
)
|
242
238
|
ctx.max_content_width = 200
|
243
239
|
ctx.ensure_object(Config)
|
244
|
-
if verbose:
|
245
|
-
click.echo(f"we are in verbose mode - server is {server}")
|
246
240
|
|
247
241
|
|
248
242
|
#
|
@@ -355,7 +349,7 @@ def show_tech(ctx):
|
|
355
349
|
pass
|
356
350
|
|
357
351
|
|
358
|
-
@show_tech.group("
|
352
|
+
@show_tech.group("tech-info")
|
359
353
|
@click.pass_context
|
360
354
|
def show_tech_info(ctx):
|
361
355
|
"""Show various Egeria information"""
|
@@ -1128,6 +1122,7 @@ def tell_glossary(ctx):
|
|
1128
1122
|
|
1129
1123
|
tell_glossary.add_command(create_glossary)
|
1130
1124
|
tell_glossary.add_command(delete_glossary)
|
1125
|
+
tell_glossary.add_command(delete_term)
|
1131
1126
|
tell_glossary.add_command(create_term)
|
1132
1127
|
tell_glossary.add_command(import_terms)
|
1133
1128
|
tell_glossary.add_command(export_terms)
|
@@ -1144,7 +1139,6 @@ tell_cat_todo.add_command(mark_todo_complete)
|
|
1144
1139
|
tell_cat_todo.add_command(reassign_todo)
|
1145
1140
|
tell_cat_todo.add_command(delete_todo)
|
1146
1141
|
tell_cat_todo.add_command(create_todo)
|
1147
|
-
tell_cat_todo.add_command(delete_term)
|
1148
1142
|
|
1149
1143
|
|
1150
1144
|
@show_cat_info.command("tech-types")
|
@@ -140,13 +140,6 @@ from pyegeria.commands.tech.list_asset_types import display_asset_types
|
|
140
140
|
help="Egeria user password",
|
141
141
|
)
|
142
142
|
@click.option("--timeout", default=60, help="Number of seconds to wait")
|
143
|
-
@click.option("--verbose", is_flag=True, default=False, help="Enable verbose mode")
|
144
|
-
@click.option(
|
145
|
-
"--paging",
|
146
|
-
is_flag=True,
|
147
|
-
default=False,
|
148
|
-
help="Enable paging snapshots vs live updates",
|
149
|
-
)
|
150
143
|
@click.option(
|
151
144
|
"--jupyter",
|
152
145
|
is_flag=True,
|
@@ -176,8 +169,6 @@ def cli(
|
|
176
169
|
userid,
|
177
170
|
password,
|
178
171
|
timeout,
|
179
|
-
paging,
|
180
|
-
verbose,
|
181
172
|
jupyter,
|
182
173
|
width,
|
183
174
|
):
|
@@ -196,15 +187,11 @@ def cli(
|
|
196
187
|
userid,
|
197
188
|
password,
|
198
189
|
timeout,
|
199
|
-
paging,
|
200
|
-
verbose,
|
201
190
|
jupyter,
|
202
191
|
width,
|
203
192
|
)
|
204
193
|
ctx.max_content_width = 200
|
205
194
|
ctx.ensure_object(Config)
|
206
|
-
if verbose:
|
207
|
-
click.echo(f"we are in verbose mode - server is {server}")
|
208
195
|
|
209
196
|
|
210
197
|
@cli.group("show")
|
@@ -607,6 +594,7 @@ tell_glossary.add_command(delete_glossary)
|
|
607
594
|
tell_glossary.add_command(create_term)
|
608
595
|
tell_glossary.add_command(import_terms)
|
609
596
|
tell_glossary.add_command(export_terms)
|
597
|
+
tell_glossary.add_command(delete_term)
|
610
598
|
|
611
599
|
|
612
600
|
@tell.group("todo")
|
@@ -620,7 +608,6 @@ tell_todo.add_command(mark_todo_complete)
|
|
620
608
|
tell_todo.add_command(reassign_todo)
|
621
609
|
tell_todo.add_command(delete_todo)
|
622
610
|
tell_todo.add_command(create_todo)
|
623
|
-
tell_todo.add_command(delete_term)
|
624
611
|
|
625
612
|
|
626
613
|
# @tell.group("survey")
|
@@ -115,13 +115,6 @@ from pyegeria.commands.my.todo_actions import (
|
|
115
115
|
help="Egeria user password",
|
116
116
|
)
|
117
117
|
@click.option("--timeout", default=60, help="Number of seconds to wait")
|
118
|
-
@click.option("--verbose", is_flag=True, default=False, help="Enable verbose mode")
|
119
|
-
@click.option(
|
120
|
-
"--paging",
|
121
|
-
is_flag=True,
|
122
|
-
default=False,
|
123
|
-
help="Enable paging snapshots vs live updates",
|
124
|
-
)
|
125
118
|
@click.option(
|
126
119
|
"--jupyter",
|
127
120
|
is_flag=True,
|
@@ -151,8 +144,6 @@ def cli(
|
|
151
144
|
userid,
|
152
145
|
password,
|
153
146
|
timeout,
|
154
|
-
paging,
|
155
|
-
verbose,
|
156
147
|
jupyter,
|
157
148
|
width,
|
158
149
|
):
|
@@ -171,15 +162,11 @@ def cli(
|
|
171
162
|
userid,
|
172
163
|
password,
|
173
164
|
timeout,
|
174
|
-
paging,
|
175
|
-
verbose,
|
176
165
|
jupyter,
|
177
166
|
width,
|
178
167
|
)
|
179
168
|
ctx.max_content_width = 200
|
180
169
|
ctx.ensure_object(Config)
|
181
|
-
if verbose:
|
182
|
-
click.echo(f"we are in verbose mode - server is {server}")
|
183
170
|
|
184
171
|
|
185
172
|
@cli.group("show")
|
@@ -129,13 +129,6 @@ from pyegeria.commands.ops.list_archives import display_archive_list
|
|
129
129
|
help="Egeria user password",
|
130
130
|
)
|
131
131
|
@click.option("--timeout", default=60, help="Number of seconds to wait")
|
132
|
-
@click.option("--verbose", is_flag=True, default=False, help="Enable verbose mode")
|
133
|
-
@click.option(
|
134
|
-
"--paging",
|
135
|
-
is_flag=True,
|
136
|
-
default=False,
|
137
|
-
help="Enable paging snapshots vs live updates",
|
138
|
-
)
|
139
132
|
@click.option(
|
140
133
|
"--jupyter",
|
141
134
|
is_flag=True,
|
@@ -165,8 +158,6 @@ def cli(
|
|
165
158
|
userid,
|
166
159
|
password,
|
167
160
|
timeout,
|
168
|
-
paging,
|
169
|
-
verbose,
|
170
161
|
jupyter,
|
171
162
|
width,
|
172
163
|
):
|
@@ -185,15 +176,11 @@ def cli(
|
|
185
176
|
userid,
|
186
177
|
password,
|
187
178
|
timeout,
|
188
|
-
paging,
|
189
|
-
verbose,
|
190
179
|
jupyter,
|
191
180
|
width,
|
192
181
|
)
|
193
182
|
ctx.max_content_width = 200
|
194
183
|
ctx.ensure_object(Config)
|
195
|
-
if verbose:
|
196
|
-
click.echo(f"we are in verbose mode - server is {server}")
|
197
184
|
|
198
185
|
|
199
186
|
@cli.group("show")
|
@@ -126,13 +126,6 @@ from pyegeria.commands.tech.get_tech_type_template import template_viewer
|
|
126
126
|
help="Egeria user password",
|
127
127
|
)
|
128
128
|
@click.option("--timeout", default=60, help="Number of seconds to wait")
|
129
|
-
@click.option("--verbose", is_flag=True, default=False, help="Enable verbose mode")
|
130
|
-
@click.option(
|
131
|
-
"--paging",
|
132
|
-
is_flag=True,
|
133
|
-
default=False,
|
134
|
-
help="Enable paging snapshots vs live updates",
|
135
|
-
)
|
136
129
|
@click.option(
|
137
130
|
"--jupyter",
|
138
131
|
is_flag=True,
|
@@ -162,8 +155,6 @@ def cli(
|
|
162
155
|
userid,
|
163
156
|
password,
|
164
157
|
timeout,
|
165
|
-
paging,
|
166
|
-
verbose,
|
167
158
|
jupyter,
|
168
159
|
width,
|
169
160
|
):
|
@@ -182,15 +173,11 @@ def cli(
|
|
182
173
|
userid,
|
183
174
|
password,
|
184
175
|
timeout,
|
185
|
-
paging,
|
186
|
-
verbose,
|
187
176
|
jupyter,
|
188
177
|
width,
|
189
178
|
)
|
190
179
|
ctx.max_content_width = 200
|
191
180
|
ctx.ensure_object(Config)
|
192
|
-
if verbose:
|
193
|
-
click.echo(f"we are in verbose mode - server is {server}")
|
194
181
|
|
195
182
|
|
196
183
|
@cli.group("show")
|
@@ -2,13 +2,24 @@ import click
|
|
2
2
|
|
3
3
|
|
4
4
|
class Config(object):
|
5
|
-
def __init__(
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
5
|
+
def __init__(
|
6
|
+
self,
|
7
|
+
server: str = None,
|
8
|
+
url: str = None,
|
9
|
+
view_server: str = "view-server",
|
10
|
+
view_server_url: str = "https://localhost:9443",
|
11
|
+
integration_daemon: str = "integration-daemon",
|
12
|
+
integration_daemon_url: str = "https://localhost:9443",
|
13
|
+
engine_host: str = "engine-host",
|
14
|
+
engine_host_url: str = "https://localhost:9443",
|
15
|
+
admin_user: str = "garygeeke",
|
16
|
+
admin_user_password: str = "secret",
|
17
|
+
userid: str = None,
|
18
|
+
password: str = None,
|
19
|
+
timeout: int = 30,
|
20
|
+
jupyter: bool = False,
|
21
|
+
width: int = 200,
|
22
|
+
):
|
12
23
|
self.metadata_store = server
|
13
24
|
self.metadata_store_url = url
|
14
25
|
self.view_server = view_server
|
@@ -22,8 +33,6 @@ class Config(object):
|
|
22
33
|
self.userid = userid
|
23
34
|
self.password = password
|
24
35
|
self.timeout = timeout
|
25
|
-
self.paging = paging
|
26
|
-
self.verbose = verbose
|
27
36
|
self.jupyter = jupyter
|
28
37
|
self.width = width
|
29
38
|
self.server = server
|
Binary file
|
@@ -129,15 +129,24 @@ Will provide a good overview.
|
|
129
129
|
|
130
130
|
A good first use is to validate that we are able to communicate with an Egeria platform and check the status of the running servers. We can do this by typing:
|
131
131
|
|
132
|
-
`hey_egeria ops show servers`
|
132
|
+
`hey_egeria ops show servers status`
|
133
133
|
|
134
134
|
Which should produce an output similar to:
|
135
|
+

|
136
|
+
**N.B. if you are trying this out in your terminal, you may need to type either `ctrl-c` or `q` to quit the display.
|
135
137
|
|
136
|
-
|
138
|
+
We can also execute a variation of this command to display an extended version of this status.
|
137
139
|
|
138
|
-
`hey_egeria
|
140
|
+
`hey_egeria ops show servers status --full`
|
141
|
+
which will return much more descriptive information about the servers and their status:
|
139
142
|
|
140
|
-
|
143
|
+

|
144
|
+
|
145
|
+
The general structure of the command is:
|
146
|
+
|
147
|
+
`hey_egeria` [area] [show/tell] [object] [command] [required parameters] [--optional parameters]
|
148
|
+
|
149
|
+
* `hey_egeria` - this is the shell level command
|
141
150
|
* [area] - there are currently four areas of commands that roughly correspond to user roles. They are:
|
142
151
|
* cat - for catalog users - this is for general usage of Egeria as a governance catalog.
|
143
152
|
* my - for individual information - these commands are relevant to an individual such as my_todos.
|
@@ -148,15 +157,140 @@ For example, above we requested to be shown the status of Egeria servers on a pl
|
|
148
157
|
* [required parameters] - parameters are sometimes required by a command.
|
149
158
|
* [optional parameters] - most parameters are optional and have sensible defaults so that you don't have to type them in.
|
150
159
|
|
160
|
+
A more visual representation of **hey_egeria** is shown in the following two diagrams. The first shows the structure
|
161
|
+
and the second shows the structure and all the commands. **PLEASE NOTE** - **hey_egeria** continues to evolve; view all
|
162
|
+
images as representing a point-in-time representation. The principles will hold true but details may vary.
|
163
|
+
|
164
|
+

|
165
|
+
|
166
|
+

|
167
|
+
|
151
168
|
There is a lot of detail here that can seem a bit daunting to learn - so to make things easier, we have a TUI
|
152
169
|
(Textual User Interface) that allows us to browse through the commands with documentation and guidance about how to fill out each command - and then to execute the command. Here is what it looks like:
|
153
170
|
|
154
|
-

|
172
|
+
|
155
173
|
Lets review the numbered annotations in the screenshot above:
|
156
174
|
|
157
|
-
1) The left hand side is a scrollable list of commands organized
|
175
|
+
1) The left hand side is a scrollable list of commands organized as discussed above. Clicking on a command
|
176
|
+
will cause details to be displayed on the right hand pane.
|
177
|
+
2) At the top of the right hand pane is a brief command description.
|
178
|
+
3) Below this description is a search bar that allows you to search for parameters to fill out and review. You will notice
|
179
|
+
that the list of parameters is scrollable - often more than will fit in the space allocated - so search can be handy.
|
180
|
+
4) The bottom command bar shows the equivalent shell command that is being built through your parameter selections in the TUI.
|
181
|
+
If you are going to use this command often, you could copy this command and create a shell alias for it - or just execute
|
182
|
+
it in the terminal window.
|
183
|
+
5) Pressing this button or typing `ctrl-R` will execute the command that you are building and return you to the terminal window
|
184
|
+
to view the results.
|
185
|
+
|
158
186
|
## Working with the TUI
|
159
187
|
|
188
|
+
We can return to the example above, this time using the TUI to help us fill out the parameters. Here is what the TUI
|
189
|
+
looks like to execute the same command:
|
190
|
+
|
191
|
+

|
192
|
+
To show the full version of the server status we would select the check-box for --full as shown here:
|
193
|
+
|
194
|
+

|
195
|
+
As you can see, the TUI provides visibility into the available command options as well as descriptive text explaining
|
196
|
+
what they are.
|
197
|
+
|
198
|
+
In addition to getting a quick overview of all of the servers, we often
|
199
|
+
want to see more details about a specific kind of server. For instance, to view a status of an Egeria integration server
|
200
|
+
we would use `hey_egeria ops show integrations status` which we could either type at the terminal or enter via the TUI.
|
201
|
+
The output of this command looks like:
|
202
|
+
|
203
|
+

|
204
|
+
|
205
|
+
There are a few different styles of output. Some of the tables are **live monitors**. That is, the commands run until interrupted by either a failure or the user typing `ctrl-c`. They reflect the status of
|
206
|
+
the object they are monitoring. Quite useful for operational monitoring - but the number of rows displayed is limited by
|
207
|
+
your current screen size. There are different techniques we use to work around this limitation but the simplest is to
|
208
|
+
enable a **list** (also sometimes called **paging**) version of the command that allows you to page through all the results using a syntax similar to
|
209
|
+
the Unix style **more** or **less** commands. To enable this version of the command we can look for
|
210
|
+
the `list` flag in the parameter list of the TUI like this:
|
211
|
+
|
212
|
+

|
213
|
+
|
214
|
+
The list view looks a bit different, but contains the same information.
|
215
|
+
|
216
|
+

|
217
|
+
|
218
|
+
Pressing the `space-bar` will advance the page. You can exit the display by pressing `q`. There are other options
|
219
|
+
that generally follow the syntax of the `more` command.
|
220
|
+
|
221
|
+
## Taking action
|
222
|
+
|
223
|
+
So far we have demonstrated how to display information with hey_egeria - but we can also tell it to perform a variety of actions.
|
224
|
+
These actions could be very simple (start a server) or more complex, requiring multiple fields of information such as
|
225
|
+
create a glossary term. If the user specified in the command has permissions then the action will be performed.
|
226
|
+
|
227
|
+
As an example, lets look at the command to load a content pack (or archive) into a repository. The
|
228
|
+
TUI page looks like this:
|
229
|
+

|
230
|
+
|
231
|
+
Creating a glossary term looks like:
|
232
|
+

|
233
|
+
|
234
|
+
Building and managing glossaries is explained in more detail in a separate tutorial.
|
235
|
+
|
236
|
+
## Working in a specific role
|
237
|
+
|
238
|
+
The number and variety of commands continues to expand. To make it a bit easier to find the right function
|
239
|
+
we also have subsets of **hey_egeria** available for the major roles/perspectives. There are:
|
240
|
+
|
241
|
+
* hey_egeria_cat - for catalog users
|
242
|
+
* hey_egeria_my - for personal tasks
|
243
|
+
* hey_egeria_ops - for operations
|
244
|
+
* hey_egeria_tech - for technical use
|
245
|
+
|
246
|
+
The structure and use of these is quite similar to **hey_egeria** - however, these commands can be a bit
|
247
|
+
simpler if you focus on one of the above areas.
|
248
|
+
|
249
|
+
# Adapting to your environment
|
250
|
+
|
251
|
+
Commands in the hey_egeria TUI have parameters to adapt to your environment. These parameters set
|
252
|
+
the endpoints, server names and user information for the commands to use. There is a default set of values that
|
253
|
+
matches the default environment for Egeria Workspaces [overview](https://egeria-project.org/try-egeria/overview/) as well
|
254
|
+
as many of our samples, labs and demos. These defaults can be easily changed; both in a shell environment, by changing
|
255
|
+
the values of the corresponding environment variables or in the TUI by over-riding defaults using the optional parameters.
|
256
|
+
Here is a list of the variables and their defaults:
|
257
|
+
|
258
|
+
| Environment Variable | Default | Command Option | Description |
|
259
|
+
|-------------------------------|------------------------|--------------------------|------------------------------------------------------------|
|
260
|
+
| EGERIA_JUPYTER | True | --jupyter | Set to True for better display in Jupyter notebooks |
|
261
|
+
| EGERIA_USER | erinoverview | --userid | A typical Egeria user |
|
262
|
+
| EGERIA_USER_PASSWORD | secret | --password | User password |
|
263
|
+
| EGERIA_ADMIN_USE | garygeeke | --admin_user | A user that configures and operates Egeria platform |
|
264
|
+
| EGERIA_ADMIN_PASSWORD | secret | --admin_user_password | Admin password |
|
265
|
+
| EGERIA_ENGINE_HOST | engine-host | --engine_host | Egeria Engine host to use for governance actions/processes |
|
266
|
+
| EGERIA_ENGINE_HOST_URL | https://localhost:9443 | --engine_host_url | Platform URL where Engine host is running |
|
267
|
+
| EGERIA_INTEGRATION_DAEMON | integration-daemon | --integration-daemon | Egeria integration daemon to use |
|
268
|
+
| EGERIA_INTEGRATION_DAEMON_URL | https://localhost:9443 | --integration_daemon_url | Platform URL where Integration daemon is running |
|
269
|
+
| EGERIA_VIEW_SERVER | view-server | --view_server | Egeria view server to use |
|
270
|
+
| EGERIA_VIEW_SERVER_URL | https://localhost:9443 | --view_server_url | Platform URL where view server is running |
|
271
|
+
| EGERIA_PLATFORM_URL | https://localhost:9443 | --url | Platform URL where chosen Egeria metadata store is running |
|
272
|
+
| EGERIA_METADATA_STORE | active-metadata-store | --server | Egeria metadata store to use |
|
273
|
+
| EGERIA_WIDTH | 200 | --width | Width of the terminal screen to use for displaying results |
|
274
|
+
| EGERIA_TIMEOUT | 60 | --timeout | Timeout for Egeria actions |
|
275
|
+
|
276
|
+
Egeria workspaces changes some of these defaults for the Docker environment it sets up. A kubernetes deployment may similarly alter the defaults
|
277
|
+
to accommodate deployment. Note that this is a very simplistic use of user identity and password. This can be augmented by using the
|
278
|
+
[Secrets Connector](https://egeria-project.org/concepts/secrets-store-connector).
|
279
|
+
|
280
|
+
# Advanced Use
|
281
|
+
This section briefly discusses some more advanced topics on the use and extension of the pyegeria commands and CLI.
|
282
|
+
## Using the CLI from the command line
|
283
|
+
As we have shown, CLI commands can be used directly in a terminal window without using the TUI.
|
284
|
+
For frequently used commands this can be a bit quicker.
|
285
|
+
|
286
|
+
|
287
|
+
## Direct commands
|
288
|
+
## How this is implemented
|
289
|
+
## Making changes
|
290
|
+
|
291
|
+
# Feedback
|
292
|
+
|
293
|
+
|
160
294
|
|
161
295
|
|
162
296
|
----
|
Binary file
|
Binary file
|
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731421782704.png
ADDED
Binary file
|
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731422134920.png
ADDED
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
@@ -36,7 +36,6 @@ EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
|
|
36
36
|
@click.command("load-archive")
|
37
37
|
@click.option(
|
38
38
|
"--file_name",
|
39
|
-
prompt="Enter the name of the archive to load",
|
40
39
|
default="content-packs/CocoComboArchive.omarchive",
|
41
40
|
help="Full path on the Metadata Server to the archive file to load",
|
42
41
|
)
|
@@ -162,20 +162,20 @@ def display_status(
|
|
162
162
|
|
163
163
|
def main():
|
164
164
|
parser = argparse.ArgumentParser()
|
165
|
-
parser.add_argument("--
|
165
|
+
parser.add_argument("--full", default=True, help="Extended Information?")
|
166
166
|
parser.add_argument("--server", help="Name of the server to display status for")
|
167
167
|
parser.add_argument("--url", help="URL Platform to connect to")
|
168
168
|
parser.add_argument("--userid", help="User Id")
|
169
169
|
parser.add_argument("--password", help="User Password")
|
170
170
|
args = parser.parse_args()
|
171
171
|
|
172
|
-
|
172
|
+
full = args.extended if args.extended is not None else False
|
173
173
|
server = args.server if args.server is not None else EGERIA_VIEW_SERVER
|
174
174
|
url = args.url if args.url is not None else EGERIA_PLATFORM_URL
|
175
175
|
userid = args.userid if args.userid is not None else EGERIA_ADMIN_USER
|
176
176
|
user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
|
177
177
|
|
178
|
-
display_status(
|
178
|
+
display_status(full, server, url, userid, user_pass)
|
179
179
|
|
180
180
|
|
181
181
|
if __name__ == "__main__":
|
@@ -34,21 +34,23 @@ pyegeria/commands/cat/list_terms.py,sha256=1xHNMgB03OVxskj63vDS7-p1OEhMNyxvlTmg8
|
|
34
34
|
pyegeria/commands/cat/list_todos.py,sha256=iPxHRyW3X5tiREio4TUOwRPvNPjU0gxm3pVnUI79ir4,6542
|
35
35
|
pyegeria/commands/cat/list_user_ids.py,sha256=7JinL7rknPbGusIb8ikXKEaV1vvbuvx_WWtbmlfS_DY,5093
|
36
36
|
pyegeria/commands/cli/__init__.py,sha256=hpTVSMP2gnPRhcAZPdeUEsQ-eaDySlXlk239dNWYmng,292
|
37
|
-
pyegeria/commands/cli/egeria.py,sha256=
|
38
|
-
pyegeria/commands/cli/egeria_cat.py,sha256=
|
39
|
-
pyegeria/commands/cli/egeria_my.py,sha256=
|
40
|
-
pyegeria/commands/cli/egeria_ops.py,sha256=
|
41
|
-
pyegeria/commands/cli/egeria_tech.py,sha256=
|
42
|
-
pyegeria/commands/cli/ops_config.py,sha256
|
37
|
+
pyegeria/commands/cli/egeria.py,sha256=aqAOPdgFZ4JVmudF2uLWmVz2u7Nhd9wr6SpLcID7GLw,44508
|
38
|
+
pyegeria/commands/cli/egeria_cat.py,sha256=OjV9w9g0r8JbiWA-alC0K2XKkRKDcIgoSuWHnIE8hU4,15871
|
39
|
+
pyegeria/commands/cli/egeria_my.py,sha256=YsOy1rqDr9MFOoxpleXAo9dMlLI3NfHYf_NobKEdKk8,5888
|
40
|
+
pyegeria/commands/cli/egeria_ops.py,sha256=xw7C63jPgjQaogl7UZZJHoDnMzoZEMwy6oh1px053Cs,12265
|
41
|
+
pyegeria/commands/cli/egeria_tech.py,sha256=oky6p9SnAMw-oCLd2revcXMOLJ-lg9884vLM8PG4A84,13968
|
42
|
+
pyegeria/commands/cli/ops_config.py,sha256=-fTndSzs1zDmWwKk8hu6FMtBwOyXrZKpIemgykhpigI,1379
|
43
43
|
pyegeria/commands/doc/.DS_Store,sha256=8NYo_wnhWZfLpkPld7Y2BV4ZsmywSTUkalhulBRf3qY,10244
|
44
44
|
pyegeria/commands/doc/command-overview.md,sha256=tnefqWz88GUMRi0TpcE5KAmeMCpvdSF6z4gVt8y_yzs,6673
|
45
45
|
pyegeria/commands/doc/glossary/.DS_Store,sha256=Wnz12QQr0lWsmfViLDHaDin30-503borBxFmXt1ST-o,6148
|
46
46
|
pyegeria/commands/doc/glossary/basic-glossary-tui.md,sha256=2HoFDMCbIZuh4sBA1xRuu7qHQPyGwWS-JNUm5XNZ8JE,5880
|
47
47
|
pyegeria/commands/doc/glossary/images/.DS_Store,sha256=1lFlJ5EFymdzGAUAaI30vcaaLHt3F1LwpG7xILf9jsM,6148
|
48
|
+
pyegeria/commands/doc/glossary/images/CleanShot 2024-11-12 out-integ-status-live 2024-11-12 at 16.44.12at 16.44.12@2x.png,sha256=gJoPJi0vscycUI3qrkyIWa9df1SWXMZRZkoSij-NMrE,572163
|
48
49
|
pyegeria/commands/doc/glossary/images/delete-glossary-step1 2024-11-06 at 15.47.23@2x.png,sha256=rppVqEwN1ZrSMzyXnsYqDl7fnPs0zTlE7PMmX4VUbQI,203332
|
49
50
|
pyegeria/commands/doc/glossary/images/delete-glossary-step2 2024-11-06 at 15.51.29@2x.png,sha256=tV0h6i1eRAbvAzye8iuWt0eJ14y1Crk9DovaJLGJCSA,299425
|
50
51
|
pyegeria/commands/doc/glossary/images/delete-glossary-step3 2024-11-06 at 15.53.19@2x.png,sha256=i_SJAW_CeM0fNfZ3fLrZAKdrE9LHG1zHHui86pejlkg,22826
|
51
52
|
pyegeria/commands/doc/glossary/images/delete-glossary-step4 2024-11-06 at 15.55.11@2x.png,sha256=Tp3Obg86JmsKIijn4lE_NBjX9v_C1AXPU0w0Qr3cSak,169412
|
53
|
+
pyegeria/commands/doc/glossary/images/hey_egeria 2024-11-12 at 20.38.43.png,sha256=J9g754NN27AOk_OYUPI4o0A7cM5oHUqO-P5sjUmBsxM,387071
|
52
54
|
pyegeria/commands/doc/glossary/images/out-create-glossary example 2024-11-05 at 20.38.04@2x.png,sha256=OH-Lsh2wOP-6XoFOHc3aAKIRZcY9usvTzNFbfjhdVzU,28900
|
53
55
|
pyegeria/commands/doc/glossary/images/out-create-term 2024-11-06 at 20.48.29.png,sha256=C8VHV3Dynig-ACrezeCK-24WqbKkK45U8cBbN54RQRY,36189
|
54
56
|
pyegeria/commands/doc/glossary/images/out-delete-term 2024-11-07 at 03.57.25.png,sha256=eN4Py_yZpr_t-OJatHk19eaxRiG_zy4l8KyC6uVwSF8,33081
|
@@ -80,13 +82,21 @@ pyegeria/commands/doc/glossary/images/tui-show-glossary-terms 2024-11-05 at 19.3
|
|
80
82
|
pyegeria/commands/doc/glossary/images/tui-upsert 2024-11-07 at 11.49.04.png,sha256=tLM_fX53WHDL3bALqvTugOsq_v-CcwaLQpJ0325gewE,347024
|
81
83
|
pyegeria/commands/doc/glossary/images/upsert-example.om-terms 2024-11-07 at 11.44.05.png,sha256=h0VE0ybRygOToKYnRplTwXcQlK4H7AzCySO7YEfkKuc,174761
|
82
84
|
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/.DS_Store,sha256=A7HmN0yPuXFNPV4Ztmp7X2mtEux6abma1DUlmHHntt4,6148
|
83
|
-
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/hey_egeria: overview.md,sha256=
|
85
|
+
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/hey_egeria: overview.md,sha256=A-FRkpNaWMyVRZzmZYoqQZi1LB8zwsX2qVZggXDVjPk,16368
|
86
|
+
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/.DS_Store,sha256=1lFlJ5EFymdzGAUAaI30vcaaLHt3F1LwpG7xILf9jsM,6148
|
87
|
+
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/CleanShot 2024-11-12 at 20.38.43@2x.png,sha256=YfgarGybJkKH2BSxIHDwKreCfsm3GnjJ0SgYLCrxbFI,401029
|
88
|
+
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731421782704.png,sha256=8lfyO8prtahjTqqT4Uk3HSICipBpf1ly2bXp00csRb8,314990
|
89
|
+
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731422134920.png,sha256=Ri4xBHuYzsMrOpoq48-3UkfQNLm9coJxLT_LJGNIU80,745535
|
90
|
+
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/out-integ-status-list 2024-11-12 at 16.45.26.png,sha256=BJ1oK6Ds-Flyz5G2ve_OXUjwzyCjvUM6BrdP3wvFs7c,571445
|
91
|
+
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/out-integ-status-live 2024-11-12 at 16.44.12@2x.png,sha256=M8qFds2-WSXLaaOeyNXPhpx0OWXwvfHCzZwYdKRvTMk,572140
|
84
92
|
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/out-server-status 2024-11-10 at 18.15.42@2x.png,sha256=6lNUyaasNqKENohRu_Q_NFQ9sz77pOO0256IZTPDvj4,152025
|
85
93
|
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/out-server-status-full 2024-11-10 at 18.25.14@2x.png,sha256=i5I7-eS6khcPTJ9Yao9vnge9qVMCJ-DyBM8TLNoNsNY,458855
|
86
|
-
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-hey-egeria
|
94
|
+
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-hey-egeria.png,sha256=WP7FdqD_tZ7m0W-7eer-YhvUA_9T5pVPm46Av6yuqNw,1213272
|
95
|
+
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-integration-status-paging.png,sha256=dp_u0abblSpe-osElW0m_2dP36meeOYI_AXCna66DRE,987553
|
87
96
|
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-load-archive 2024-11-10 at 19.19.09@2x.png,sha256=VqI0ELwROkRCWAbVqAPVAq1mFU_WPviG1r3ztMHZEMs,1415244
|
88
97
|
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-show-server-status 2024-11-10 at 18.52.01@2x.png,sha256=DXho3lr45D7honmcWlG-3_diQTlADCiKxf0wizmwH84,1577495
|
89
98
|
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-show-server-status-full 2024-11-10.png,sha256=9V6zT5DmyAB7CdfLepo0_vV3wAUDOTQy5pnAhIlOKd4,1499530
|
99
|
+
pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/tui-status-paging 2024-11-12 at 16.26.14@2x.png,sha256=EzuCQpKK-udRwnBv0Gj5LlCGVa0zLMWPmH1_uWpgnHk,917561
|
90
100
|
pyegeria/commands/my/README.md,sha256=ZheFhj_VoPMhcWjW3pGchHB0vH_A9PklSmrSkzKdrcQ,844
|
91
101
|
pyegeria/commands/my/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
92
102
|
pyegeria/commands/my/list_my_profile.py,sha256=7oZ-rT1WuRSatlthJP_Qlvlgf66z3PetdLYsiqrYSko,5788
|
@@ -99,7 +109,7 @@ pyegeria/commands/ops/__init__.py,sha256=GyDGBYodxuJ-7k87z2farDs9vhR__RNrYeAe94H
|
|
99
109
|
pyegeria/commands/ops/gov_server_actions.py,sha256=zdawX-yfPFakc3Xf5V6j7e-csMbRLzJ-tdt_FkIhG34,5689
|
100
110
|
pyegeria/commands/ops/list_archives.py,sha256=FEZ2XYnQIWo2PztWqnj6unn0pbblPU0-bMbTyI3csv4,5464
|
101
111
|
pyegeria/commands/ops/list_catalog_targets.py,sha256=9DgHbPmUInWPjdEp98aQjfcZbDjs40ml0NQt9PG94y0,7688
|
102
|
-
pyegeria/commands/ops/load_archive.py,sha256=
|
112
|
+
pyegeria/commands/ops/load_archive.py,sha256=QI7SqxlsHQc8cnyemQMMG0_8LsM-mTqkPo-Vqn-6A38,2692
|
103
113
|
pyegeria/commands/ops/monitor_asset_events.py,sha256=cjdlVqE0XYnoRW3aorNbsVkjByDXefPBnllaZLelGls,3838
|
104
114
|
pyegeria/commands/ops/monitor_engine_activity.py,sha256=8RX-3znYx-4oWsI8nGFwODkWZ5Fc4qPttam_twymcjs,9856
|
105
115
|
pyegeria/commands/ops/monitor_engine_activity_c.py,sha256=eW23z4KJyZFj0OCURlFodZ8qhJwepnZQU_dB6Xggk3I,10747
|
@@ -107,7 +117,7 @@ pyegeria/commands/ops/monitor_gov_eng_status.py,sha256=nR0xI_8L8W6gOJm8-jp8BaAeO
|
|
107
117
|
pyegeria/commands/ops/monitor_integ_daemon_status.py,sha256=NQVHJuZfRfSaO7WjZnziI6ckHLCl06ykliJCV_sICOI,11368
|
108
118
|
pyegeria/commands/ops/monitor_platform_status.py,sha256=E4Qf6m1dv8EqUV1-LAxWAlOrZRqNSXJgJ0i_cczW1aI,6578
|
109
119
|
pyegeria/commands/ops/monitor_server_startup.py,sha256=0pwnhv761uuFHGJXVANa5RhQQPPTXFldJ45TfeT7qfk,3901
|
110
|
-
pyegeria/commands/ops/monitor_server_status.py,sha256=
|
120
|
+
pyegeria/commands/ops/monitor_server_status.py,sha256=TLdtjt5EFR-VVC2jAZqiBlGMvtb5IjOTdtdVZfHMz0o,6878
|
111
121
|
pyegeria/commands/ops/orig_monitor_server_list.py,sha256=Uhtn8lv7QVXJBi9DSR3Nelmz8TB0vOsat10nFS6Nu20,4637
|
112
122
|
pyegeria/commands/ops/orig_monitor_server_status.py,sha256=A-8hMDfbscdcq-b1OD4wKn0tphumX8WIK-Hz8uPoFkc,3974
|
113
123
|
pyegeria/commands/ops/refresh_integration_daemon.py,sha256=WEAeaFAEWLJ055pGfzX6rkn7mq3Z0FYqJ0Xn0z1VjtA,2962
|
@@ -157,8 +167,8 @@ pyegeria/template_manager_omvs.py,sha256=heqbKeum5hPCHap4r1RUZU8YB3QaQlxVNbq4GZi
|
|
157
167
|
pyegeria/utils.py,sha256=1h6bwveadd6GpbnGLTmqPBmBk68QvxdjGTI9RfbrgKY,5415
|
158
168
|
pyegeria/valid_metadata_omvs.py,sha256=tfCGXed5LLt59YA8uZNNtd9UJ-lRZfPU_uZxK31Yux0,65069
|
159
169
|
pyegeria/x_action_author_omvs.py,sha256=xu1IQ0YbhIKi17C5a7Aq9u1Az2czwahNPpX9czmyVxE,6454
|
160
|
-
pyegeria-1.5.1.1.
|
161
|
-
pyegeria-1.5.1.1.
|
162
|
-
pyegeria-1.5.1.1.
|
163
|
-
pyegeria-1.5.1.1.
|
164
|
-
pyegeria-1.5.1.1.
|
170
|
+
pyegeria-1.5.1.1.57.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
|
171
|
+
pyegeria-1.5.1.1.57.dist-info/METADATA,sha256=NB8Fc9jPZTejjc96abN1ZLVUHmCBoBPdG9aRZlxfAnw,2998
|
172
|
+
pyegeria-1.5.1.1.57.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
|
173
|
+
pyegeria-1.5.1.1.57.dist-info/entry_points.txt,sha256=w9RxNxRMM8fmX_DFKDFRPTWTqeujjbEuGHfqORT7law,5170
|
174
|
+
pyegeria-1.5.1.1.57.dist-info/RECORD,,
|
Binary file
|
File without changes
|
File without changes
|
File without changes
|