feat!: declare annotator CLI as console entrypoint #447
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
korikuzma
approved these changes
Sep 3, 2024
|
initial feelings seem to be supportive of |
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.
Declare the annotator
clickfunction as a console entry point, enablingvrs-annotate input.vcf --vcf_out=out.vcfrather thanpython3 src/ga4gh/vrs/extras/vcf_annotation.py input.vcf --vcf_out=out.vcf.Open to suggestions on the command name. I'd prefer a structure more along the lines of
vrs-annotate vcf input.vcf --vcf_out=out.vcf(i.e.,vrs-annotateis the command,vcfis a subcommand) if we think there's a chance that other filetypes could be annotated in the future (in that case, we may want to alter the module name as well). Alternatively, though, the subcommand might be superfluous if the file argument has a suffix indicating the filetype.