-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ocs-client-cli command-line tool #218
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Neded to faciliate MatchedClients instantiated from scripts with their own command line args.
BrianJKoopman
requested changes
Aug 23, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This does look useful! I ran into one error that I think would be good to account for. Then I have a question (or maybe found a bug?) related to the --details
behavior. Details in comments below.
... instead of querying the registry, unless --use-registry.
mhasself
force-pushed
the
ocs-client-cli
branch
from
August 27, 2021 22:58
83791f2
to
d99fe71
Compare
BrianJKoopman
approved these changes
Aug 30, 2021
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Creates script ocs-client-cli, to help quickly start an interactive python/ipython session with an open MatchedClient. Also you can "scan" for Agents (and list their op's statuses). Added to docs.
Motivation and Context
This helps people avoid the boilerplate needed when all you want is a MatchedClient to debug / inspect a system. When controlling special devices folks probably have Jupyter notebooks or longer client scripts they can run. But there is a place for a general tool that can quickly connect to any Agent. It's frankly pretty useful to be able to list active Agents from the command line.
Going forward we might want to add additional debugging capabilities, such as dumping Operation session.data to the terminal.
How Has This Been Tested?
I've tested this on the miniobs, with both the python and ipython interpreters.
Types of changes
Checklist:
develop
branch.