timenet-curate¶
The producer command-line tool. It drives a connector through the
curation pipeline and writes a dataset-layout directory (a manifest.json plus its
parquet) ready for a registry. It ships with timenet-connectors, separate from the
consumer timenet tool, and needs the timenet[curation] extra that
timenet-connectors already pulls in.
Coming soon
The timenet packages aren't on PyPI yet. Install instructions land here once they ship.
The built-in connectors ship inside the package and are resolved by dataset id, so installing
timenet-connectors is enough to build them. Clone the repo only when you want to author a
connector.
timenet-curate build¶
Runs the connector for <dataset_id> through the pipeline (download, convert, derive_schema, store)
and writes the dataset into the output registry.
| Option | Default | What it does |
|---|---|---|
<dataset_id> |
required | The org/name id to build. An unknown id lists the ones that exist. |
--out <dir> |
$TIMENET_REGISTRY, else <home>/registry |
Where to write. The directory is created if absent. |
--force, -f |
off | Rebuild a version that is already curated instead of reusing it. |
--keep-cache |
off | Keep the raw download cache. It is removed after a successful build. |
--quiet, -q |
off | Suppress status output. Belongs to timenet-curate, not to build. |
--quiet goes before the subcommand
timenet-curate --quiet build <id> works. timenet-curate build <id> --quiet exits 2 with
No such option: --quiet.
If $TIMENET_REGISTRY names a remote registry (timenet://, s3://, http(s)://) there is nowhere
local to build into, so build exits 2 and asks for --out.
Output streams¶
Status lines go to stderr; the committed version directory goes to stdout on its own. A script can capture the path without parsing anything:
--quiet silences the status lines but never warnings, errors, or that stdout path.
Exit codes¶
| Code | When |
|---|---|
0 |
The dataset was built, or an already-curated version was reused. |
1 |
An expected failure (a TimeNetError): a one-line Error: ... on stderr, no traceback. |
2 |
A usage error: an unknown dataset id, a bad flag, or a remote $TIMENET_REGISTRY. |
Anything else is a bug and surfaces its traceback.
Verifying a build¶
The output directory is itself a valid local registry, so you can point the SDK straight at it:
timenet-curate build timenet/hello-world --out ./local_registry
python -c "from timenet.client import TimeNet; print(TimeNet('./local_registry').list())"
Planned commands¶
Only build exists today. validate, inspect, and publish (to an S3 or hosted registry) are
planned and land with the remote registry backends.
For the authoring loop behind these commands, see Curate & publish and Connectors.