-
Notifications
You must be signed in to change notification settings - Fork 3
feat: Add support for installing as a tool #99
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
Open
k88hudson-cfa
wants to merge
3
commits into
CDCgov:main
Choose a base branch
from
k88hudson-cfa:uv-install
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,20 +1,35 @@ | ||||||
| # griddler | ||||||
|
|
||||||
| Griddles are the main functionality of griddle. Read about the [griddle schema](griddles.md) to get started. | ||||||
| Griddles are the main functionality of griddle. Read about the [griddle schema](griddles.md) to learn more about the format. | ||||||
|
|
||||||
| ## Using griddler from the command line | ||||||
| ## Getting started | ||||||
|
|
||||||
| Griddler can also be used on the command line to read an input YAML (or JSON) and write output JSON: | ||||||
| ### Command-line usage | ||||||
|
|
||||||
| Griddler can be used from the command line with any language. It reads a YAML (or JSON) | ||||||
| griddle definition and writes the expanded parameter sets as JSON. | ||||||
|
|
||||||
| You can install it from GitHub with `uv` or another git-backed package maanger: | ||||||
|
|
||||||
| ```bash | ||||||
| uv tool install git+https://github.com/cdcgov/griddler.git | ||||||
| ``` | ||||||
| python -m griddler my_griddle.yaml > my_parameter_sets.json | ||||||
|
|
||||||
| Example usage: | ||||||
|
|
||||||
| ```bash | ||||||
| griddler my_griddle.yaml > my_parameter_sets.json | ||||||
| ``` | ||||||
|
|
||||||
| Use the `--help` flag for more details. | ||||||
|
|
||||||
| ## Using griddle in other python projects | ||||||
| ### Python API | ||||||
|
|
||||||
| You can also directly generate a griddle directly in Python: | ||||||
|
|
||||||
| You can generate a griddle directly in Python: | ||||||
| ```bash | ||||||
| uv add git+https://github.com/cdcgov/griddler.git | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| ``` | ||||||
|
|
||||||
| ```python | ||||||
| import yaml | ||||||
|
|
||||||
This file contains hidden or 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
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Confusingly "griddler" points to the R project. I wonder if this means it's time to retire that repo. Insofar as this is a CLI tool, then there should only be one.
Insofar as it's a way to manipulate experiments, then I imagine one could want multiple implementations. But it's probably better to just maintain one.