timenet-build¶
The producer command-line tool. It drives a connector through the
build pipeline. It writes a TimeF version directory that a
registry can use. The directory has a manifest.json, Parquet control tables, and
a Parquet or Zarr values plane. The tool ships with timenet-connectors, separate from the consumer
timenet tool. It needs the timenet[build] extra that timenet-connectors
already installs.
The built-in connectors ship inside the package. The tool resolves them by dataset id, so that install is enough to build them. Clone the repository only to author a connector.
timenet-build build¶
timenet-build [--quiet] build <dataset_id> \
[--out <dir>] [--force] [--keep-cache] [--no-isolation]
This command runs the connector for <dataset_id> through the pipeline: download, convert,
derive_schema, store. Then it 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. If the directory is absent, the tool creates it. |
--force, -f |
off | Rebuild a version that is already built instead of reusing it. |
--keep-cache |
off | Keep the raw download cache. The tool removes it after a successful build. |
--isolation / --no-isolation |
on | Build in an environment made from the connector's requirements.txt. --no-isolation (or TIMENET_ISOLATION=off) builds in the current interpreter. |
--quiet, -q |
off | Suppress status output. Belongs to timenet-build, not to build. |
--quiet goes before the subcommand
timenet-build --quiet build <id> works. timenet-build build <id> --quiet exits 2 with
No such option '--quiet'.
If $TIMENET_REGISTRY names a remote registry (timenet://, s3://, http(s)://), there is no
local place to build into. Then 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 tool built the dataset, or reused an already-built version. |
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 a valid local registry. You can point the SDK straight at it:
timenet-build 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. They will land with the remote registry backends.
For the authoring loop behind these commands, see Build & publish and Connectors.