Metadata-Version: 2.4
Name: timenet-connectors
Version: 0.1.0
Summary: Dataset connectors for TimeNet: dataset-specific logic to fetch and convert sources into the TimeF format.
Keywords: time-series,datasets,timef,machine-learning,connectors,etl
Author: The TimeNet authors
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Requires-Dist: aiofiles>=24.1
Requires-Dist: httpx>=0.28
Requires-Dist: jaxtyping>=0.3
Requires-Dist: numpy>=2.1
Requires-Dist: pyarrow>=21
Requires-Dist: timenet[build]>=0.0.1
Requires-Dist: typer>=0.12
Requires-Python: >=3.11
Project-URL: Homepage, https://timenet.ai
Project-URL: Documentation, https://docs.timenet.ai/
Project-URL: Repository, https://github.com/OpenTSLM/TimeNet
Project-URL: Issues, https://github.com/OpenTSLM/TimeNet/issues
Description-Content-Type: text/markdown

# timenet-connectors

Dataset connectors for [TimeNet](../timenet). A connector fetches a dataset's raw artifacts and converts
them into the shared TimeF format. The connector contract itself lives in the `timenet` package
(`timenet.connectors.BaseConnector`).

## Layout

Each concrete connector is a package folder at `datasets/<org>/<name>/`: a `connector.py` exposing a
module-level `CONNECTOR`, an `__init__.py` that re-exports it, and a `dataset.yaml` card beside them
(lowercase names; hyphens in the name become underscores on disk). They are discovered lazily by
dataset id, so there is no central registry. Reusable bases (for the HuggingFace Hub and PhysioNet)
live under `bases/`.

The card's `license` and `source_url` fields record each dataset's upstream license and where it
came from. This package's MIT license covers the connector code, not the datasets it converts.

## Build

```bash
timenet-build build timenet/hello-world        # synthetic demo
timenet-build build chengsenwang/tsqa          # a real dataset
```

A connector declares the libraries that its source needs in a `requirements.txt` beside its
`dataset.yaml`. A build installs them into the environment where the build runs. This keeps
`timenet-connectors` small.
