DM-24329: add sphinx documentation of the Click CLI in daf_butler #361
Conversation
There was a problem hiding this comment.
A few typos. I think the documentation will help someone writing a Butler/pipetask subcommand. Question about generic framework bits being in daf_butler instead of a more generic package.
Not directly related to this ticket, but not sure how to take advantage of this nice option and code reuse if using (YAML) config files instead of command line arguments.
| It then describes how other packages can add subcommands to the butler command by way of a plugin system, | ||
| in `Butler Command Plugins`_. | ||
|
|
||
| Finanly, the ``butler`` command line framework can be used to write other commands that load subcommands. This |
There was a problem hiding this comment.
Spelling typo in Finally
|
|
||
| Shared Options: | ||
|
|
||
| - Should be placed in a package that is as high in the dependcy tree as is reasonable for that option. |
There was a problem hiding this comment.
Spelling type for dependency
| Shared Arguments | ||
| ~~~~~~~~~~~~~~~~ | ||
|
|
||
| Arguments definitions can be shared, similar to options, and also should be used to improve consistency and |
There was a problem hiding this comment.
Argument definitions? (The double plural didn't read quite right).
|
|
||
| Shared Arguments: | ||
|
|
||
| - Should be placed in a package that is as high in the dependcy tree as is reasonable for that option. By |
| commands that dynamically load subcommands. | ||
|
|
||
| It's easy to create a new kind of command by copying the template below and making a few small changes: | ||
|
|
There was a problem hiding this comment.
If there is click framework code that can be used by commands that don't use a butler (or specifically butler command line options), then shouldn't the code be moved outside daf_butler?
There was a problem hiding this comment.
I spoke with @timj about this. It would be better in a different package, but right now we want to be removing dependencies from daf_butler (as opposed to adding them), and because having it here is not a gen2 deprecation blocker, we're not going to do it right now.
| ========================= | ||
|
|
||
| The ``butler`` commmand uses a ``click.MultiCommand`` subclass called ``LoaderCLI`` that dynamically loads | ||
| subcomands from the local package and from plugin packages. ``LoaderCLI`` can be used to implement other |
n8pease
force-pushed
the
tickets/DM-24329
branch
from
dfc2ff5
to
a72be8c
Compare
The documentation for the three command-line scripts has been moved to separate pages, as recommended by the developer's guide. This makes the main module page a bit easier to navigate.
n8pease
force-pushed
the
tickets/DM-24329
branch
from
e9d5b2c
to
af76d0e
Compare
No description provided.