-
Notifications
You must be signed in to change notification settings - Fork 2
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
ENH: Add cli framework #44
Conversation
I've never been happy with this re-used cli setup but I've never suggested a better way
atef has tons of overhead for doing nothing in the cli, largely in import statements |
True, maybe this is the time to try and streamline this a bit. |
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.
I don't have any particularly constructive objections, I would have preferred defining what we want to do here prior to standing up the framework though.
I'm happy to defer this until we tagup and discuss what functionality we want. I just figured we couldn't be exposing a makefile when this is in our env |
It's true, |
I like this too seems pythonic. Footnotes
|
I'll re-request reviews after this minor refactor, should be good enough as is for a first pass framework setup |
I received verbal approval from josh during out sync yesterday, and will be merging this. We can refine the command selection later |
Description
beams.__version__
)setup_logging
is calledMotivation and Context
In partial response to #10 . When this is in our environment we won't be able to ask users to find the makefile and run commands with it. This gives us standard python cli entrypoints.
I could think of a few entrypoints we might add, but didn't want to jump the gun before we discussed them.
beams run
: run a provided tree. I added this subcommand as an example, but it could use more arguments (tick rate, tick mode {continuous, fixed number, idk}, ...)beams start-server
: start the sequencer server that's currently invoked viamake run_sequencer
beams test_ioc
: start one of the test iocs we have bundled. Maybe this is replaced by acaproto
call.How Has This Been Tested?
No new tests added. interactive testing predominantly
Where Has This Been Documented?
This PR.
cli is also self-documenting now:
Pre-merge checklist
docs/pre-release-notes.sh
and created a pre-release documentation page