edge-containers-cli 4.2.0__tar.gz → 4.2.1__tar.gz

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 (106) hide show
  1. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/PKG-INFO +25 -3
  2. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/README.md +24 -2
  3. edge_containers_cli-4.2.1/docs/images/ec-logs.png +0 -0
  4. edge_containers_cli-4.2.1/docs/images/ec-web.png +0 -0
  5. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/_version.py +2 -2
  6. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/cmds/monitor.py +1 -1
  7. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli.egg-info/PKG-INFO +25 -3
  8. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli.egg-info/SOURCES.txt +2 -0
  9. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.copier-answers.yml +0 -0
  10. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.devcontainer/devcontainer.json +0 -0
  11. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/CONTRIBUTING.md +0 -0
  12. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  13. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/ISSUE_TEMPLATE/issue.md +0 -0
  14. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +0 -0
  15. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/actions/install_requirements/action.yml +0 -0
  16. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/dependabot.yml +0 -0
  17. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/pages/index.html +0 -0
  18. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/pages/make_switcher.py +0 -0
  19. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/workflows/_check.yml +0 -0
  20. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/workflows/_dist.yml +0 -0
  21. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/workflows/_pypi.yml +0 -0
  22. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/workflows/_release.yml +0 -0
  23. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/workflows/_test.yml +0 -0
  24. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/workflows/_tox.yml +0 -0
  25. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.github/workflows/ci.yml +0 -0
  26. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.gitignore +0 -0
  27. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.pre-commit-config.yaml +0 -0
  28. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.vscode/extensions.json +0 -0
  29. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.vscode/launch.json +0 -0
  30. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.vscode/settings.json +0 -0
  31. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/.vscode/tasks.json +0 -0
  32. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/Dockerfile +0 -0
  33. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/LICENSE +0 -0
  34. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/conf.py +0 -0
  35. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/explanations/decisions/0001-record-architecture-decisions.rst +0 -0
  36. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/explanations/decisions/0002-switched-to-pip-skeleton.rst +0 -0
  37. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/explanations/decisions.rst +0 -0
  38. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/how-to/build-docs.rst +0 -0
  39. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/how-to/contribute.rst +0 -0
  40. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/how-to/lint.rst +0 -0
  41. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/how-to/make-release.rst +0 -0
  42. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/how-to/pin-requirements.rst +0 -0
  43. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/how-to/run-tests.rst +0 -0
  44. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/how-to/static-analysis.rst +0 -0
  45. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/how-to/test-container.rst +0 -0
  46. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/how-to/update-tools.rst +0 -0
  47. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/index.rst +0 -0
  48. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/reference/standards.rst +0 -0
  49. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/developer/tutorials/dev-install.rst +0 -0
  50. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/genindex.rst +0 -0
  51. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/images/dls-favicon.ico +0 -0
  52. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/images/dls-logo.svg +0 -0
  53. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/index.rst +0 -0
  54. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/user/explanations/docs-structure.rst +0 -0
  55. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/user/how-to/run-container.rst +0 -0
  56. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/user/index.rst +0 -0
  57. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/user/reference/api.rst +0 -0
  58. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/docs/user/tutorials/installation.rst +0 -0
  59. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/pyproject.toml +0 -0
  60. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/setup.cfg +0 -0
  61. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/__init__.py +0 -0
  62. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/__main__.py +0 -0
  63. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/autocomplete.py +0 -0
  64. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/backend.py +0 -0
  65. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/cli.py +0 -0
  66. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/cmds/__init__.py +0 -0
  67. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/cmds/argo_commands.py +0 -0
  68. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/cmds/commands.py +0 -0
  69. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/cmds/demo_commands.py +0 -0
  70. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/cmds/helm.py +0 -0
  71. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/cmds/k8s_commands.py +0 -0
  72. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/cmds/monitor.tcss +0 -0
  73. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/definitions.py +0 -0
  74. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/git.py +0 -0
  75. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/globals.py +0 -0
  76. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/logging.py +0 -0
  77. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/shell.py +0 -0
  78. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli/utils.py +0 -0
  79. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli.egg-info/dependency_links.txt +0 -0
  80. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli.egg-info/entry_points.txt +0 -0
  81. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli.egg-info/requires.txt +0 -0
  82. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/src/edge_containers_cli.egg-info/top_level.txt +0 -0
  83. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/__init__.py +0 -0
  84. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/conftest.py +0 -0
  85. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/argocd.yaml +0 -0
  86. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-deployment/apps/values.yaml +0 -0
  87. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/bl01t-ea-test-01/Chart.yaml +0 -0
  88. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/bl01t-ea-test-01/config/ioc.db +0 -0
  89. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/bl01t-ea-test-01/config/ioc.yaml +0 -0
  90. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/bl01t-ea-test-01/templates/configmap.yaml +0 -0
  91. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/bl01t-ea-test-01/values.yaml +0 -0
  92. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/bl01t-ea-test-02/Chart.yaml +0 -0
  93. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/bl01t-ea-test-02/values.yaml +0 -0
  94. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/dls-aravis/Chart.yaml +0 -0
  95. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/dls-aravis/config/ioc.yaml +0 -0
  96. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/dls-aravis/templates/configmap.yaml +0 -0
  97. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/dls-aravis/values.yaml +0 -0
  98. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/bl01t-services/services/values.yaml +0 -0
  99. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/cli.yaml +0 -0
  100. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/k8s.yaml +0 -0
  101. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/data/yaml.yaml +0 -0
  102. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/test_argocd.py +0 -0
  103. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/test_cli.py +0 -0
  104. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/test_demo.py +0 -0
  105. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/test_k8s.py +0 -0
  106. {edge_containers_cli-4.2.0 → edge_containers_cli-4.2.1}/tests/test_unit.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: edge-containers-cli
3
- Version: 4.2.0
3
+ Version: 4.2.1
4
4
  Summary: CLI for deploying and managing epics containers IOCs and services
5
5
  Author-email: Giles Knap <giles.knap@gmail.com>
6
6
  License: Apache License
@@ -240,8 +240,12 @@ Requires-Dist: types-mock; extra == "dev"
240
240
 
241
241
  # edge_containers_cli
242
242
 
243
+ ## About
244
+
243
245
  Edge containers command line interface: a tool for deploying and managing
244
- IOCs and services in a beamline or accelerator cluster.
246
+ IOCs in a beamline or accelerator cluster. The tool is a thin wrapper around
247
+ familiar command line tools such as git, kubectl, helm and argocd - and can
248
+ be used to learn the underlying commands being used.
245
249
 
246
250
  For detailed documentation on the framework that this supports see:
247
251
  https://epics-containers.github.io/
@@ -254,7 +258,25 @@ Releases | <https://github.com/epics-containers/edge-containers-cli/relea
254
258
 
255
259
 
256
260
  To discover the CLI commands, create a python virtual environment,
257
- and perform the following::
261
+ and perform the following:
258
262
 
259
263
  pip install edge-containers-cli
260
264
  ec --version
265
+
266
+ ## Monitor
267
+
268
+ Some commands of the tool are also exposed as a TUI which can additionally be served as
269
+ a web application.
270
+
271
+ To demo the TUI as a web application:
272
+
273
+ pip install textual-dev
274
+ textual serve "ec -b DEMO monitor"
275
+
276
+ Dashboard:
277
+
278
+ ![screenshot](docs/images/ec-web.png)
279
+
280
+ IOC logs:
281
+
282
+ ![screenshot](docs/images/ec-logs.png)
@@ -5,8 +5,12 @@
5
5
 
6
6
  # edge_containers_cli
7
7
 
8
+ ## About
9
+
8
10
  Edge containers command line interface: a tool for deploying and managing
9
- IOCs and services in a beamline or accelerator cluster.
11
+ IOCs in a beamline or accelerator cluster. The tool is a thin wrapper around
12
+ familiar command line tools such as git, kubectl, helm and argocd - and can
13
+ be used to learn the underlying commands being used.
10
14
 
11
15
  For detailed documentation on the framework that this supports see:
12
16
  https://epics-containers.github.io/
@@ -19,7 +23,25 @@ Releases | <https://github.com/epics-containers/edge-containers-cli/relea
19
23
 
20
24
 
21
25
  To discover the CLI commands, create a python virtual environment,
22
- and perform the following::
26
+ and perform the following:
23
27
 
24
28
  pip install edge-containers-cli
25
29
  ec --version
30
+
31
+ ## Monitor
32
+
33
+ Some commands of the tool are also exposed as a TUI which can additionally be served as
34
+ a web application.
35
+
36
+ To demo the TUI as a web application:
37
+
38
+ pip install textual-dev
39
+ textual serve "ec -b DEMO monitor"
40
+
41
+ Dashboard:
42
+
43
+ ![screenshot](docs/images/ec-web.png)
44
+
45
+ IOC logs:
46
+
47
+ ![screenshot](docs/images/ec-logs.png)
@@ -12,5 +12,5 @@ __version__: str
12
12
  __version_tuple__: VERSION_TUPLE
13
13
  version_tuple: VERSION_TUPLE
14
14
 
15
- __version__ = version = '4.2.0'
16
- __version_tuple__ = version_tuple = (4, 2, 0)
15
+ __version__ = version = '4.2.1'
16
+ __version_tuple__ = version_tuple = (4, 2, 1)
@@ -385,7 +385,7 @@ class MonitorApp(App):
385
385
  Binding("r", "restart_ioc", "Restart IOC"),
386
386
  Binding("l", "ioc_logs", "IOC Logs"),
387
387
  Binding("o", "sort", "Sort"),
388
- Binding("d", "toggle_dark", "Toggle dark mode"),
388
+ # Binding("d", "toggle_dark", "Toggle dark mode"),
389
389
  ]
390
390
 
391
391
  def __init__(
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: edge-containers-cli
3
- Version: 4.2.0
3
+ Version: 4.2.1
4
4
  Summary: CLI for deploying and managing epics containers IOCs and services
5
5
  Author-email: Giles Knap <giles.knap@gmail.com>
6
6
  License: Apache License
@@ -240,8 +240,12 @@ Requires-Dist: types-mock; extra == "dev"
240
240
 
241
241
  # edge_containers_cli
242
242
 
243
+ ## About
244
+
243
245
  Edge containers command line interface: a tool for deploying and managing
244
- IOCs and services in a beamline or accelerator cluster.
246
+ IOCs in a beamline or accelerator cluster. The tool is a thin wrapper around
247
+ familiar command line tools such as git, kubectl, helm and argocd - and can
248
+ be used to learn the underlying commands being used.
245
249
 
246
250
  For detailed documentation on the framework that this supports see:
247
251
  https://epics-containers.github.io/
@@ -254,7 +258,25 @@ Releases | <https://github.com/epics-containers/edge-containers-cli/relea
254
258
 
255
259
 
256
260
  To discover the CLI commands, create a python virtual environment,
257
- and perform the following::
261
+ and perform the following:
258
262
 
259
263
  pip install edge-containers-cli
260
264
  ec --version
265
+
266
+ ## Monitor
267
+
268
+ Some commands of the tool are also exposed as a TUI which can additionally be served as
269
+ a web application.
270
+
271
+ To demo the TUI as a web application:
272
+
273
+ pip install textual-dev
274
+ textual serve "ec -b DEMO monitor"
275
+
276
+ Dashboard:
277
+
278
+ ![screenshot](docs/images/ec-web.png)
279
+
280
+ IOC logs:
281
+
282
+ ![screenshot](docs/images/ec-logs.png)
@@ -45,6 +45,8 @@ docs/developer/reference/standards.rst
45
45
  docs/developer/tutorials/dev-install.rst
46
46
  docs/images/dls-favicon.ico
47
47
  docs/images/dls-logo.svg
48
+ docs/images/ec-logs.png
49
+ docs/images/ec-web.png
48
50
  docs/user/index.rst
49
51
  docs/user/explanations/docs-structure.rst
50
52
  docs/user/how-to/run-container.rst