This document describes the command-line interface (CLI) as a development reference and to track implementation status.
We use symbols to indicate the status of implementation (see table below). For planned or in-progress work, we might include signatures, docstrings, and pseudocode to clarify the design. Once the interface is implemented, these are replaced by links to the reference documentation.
| Status | Description |
|---|---|
| Interface that has been implemented. | |
| Interface that is currently being worked on. | |
| Interface that is planned, but isn’t being worked on currently. |
seedcase-sproutseedcase-sprout has the following signature:
When used on its own, seedcase-sprout shows the help message as a shorthand for --help:
As a convenience, we provide the command sprout as a shorthand for seedcase-sprout. It can be used in place of seedcase-sprout in all instances.
seedcase-sprout has several commands: extract-metadata, create-template, build-resources, build-metadata, and build that runs the other build-* commands. These commands are described below.
extract-metadataThe extract-metadata command extracts metadata from a Parquet file and outputs a Python script with the ResourceProperties() dataclass filled in with the extracted metadata. It is meant to be used with Parquet files in the staging/ directory that have the same schema (columns and data types) as the final resource. It has the signature:
flowchart LR
parquet[/"Parquet path<br>[PARQUET-PATH]"/]
output_opt["Output path<br>[--output]"]
extract["extract-metadata"]
output[/"Python script<br>[File]"/]
parquet --> extract
output_opt --> extract
extract --> output
extract-metadata command.