Open
Conversation
wei-qlu
force-pushed
the
python/update-changelog
branch
from
f4ba3aa to
971471e
Compare
wei-qlu
changed the title
marc-sift
reviewed
Apr 22, 2026
| #### Data Import API in SiftClient | ||
| The `sift_client` module now exposes a data import API supporting CSV, Parquet, TDMS, and HDF5. With this addition, all features previously available only in `sift_py` are now available in `sift_client`, which remains the recommended interface for new development. `sift_py` (deprecated since [v0.10.0](#v0100---january-30-2026)) continues to work and ship in this release. | ||
|
|
||
| Migrating from `sift_py`: the per-format upload services (`CsvUploadService`, `ParquetUploadService`, `Hdf5UploadService`, `TdmsUploadService`) are replaced by a single `client.data_import.import_from_path` method. Where `sift_py` required hand-building a config object for every import, `sift_client` auto-detects it from the file extension. Use the new public `client.data_import.detect_config(...)` first if you need to inspect or patch the result before importing. `import_from_path` returns a `Job` you can optionally wait on. |
Contributor
There was a problem hiding this comment.
sift_py contained simple_upload variants that did not require hand building a config. We should include some information telling users they don't need to use a dedicated function anything and can instead pass in an empty config to rely on auto detection.
| Format-by-format support: | ||
| - **CSV**: auto-detected from `.csv`. Supports an optional JSON metadata row (row 1 or row 2) for specifying channel names, units, data types, and the time column format. | ||
| - **Parquet**: requires an explicit `data_type` (`PARQUET_FLATDATASET` or `PARQUET_SINGLE_CHANNEL_PER_ROW`) since `.parquet` alone doesn't disambiguate the layout. Detection only reads the file footer, so it stays fast on large files. | ||
| - **HDF5**: new in this release. Auto-detected from `.h5` / `.hdf5`. Detection runs fully client-side (no server round-trip) and walks each dataset. |
Contributor
There was a problem hiding this comment.
I think it's less important to mention that it all happens client side, and more important to mention that the auto detection works if your HDF5 format is in a specific layout. Otherwise, you will need to create your own config.
Comment on lines
+35
to
+36
| - **HDF5**: new in this release. Auto-detected from `.h5` / `.hdf5`. Detection runs fully client-side (no server round-trip) and walks each dataset. | ||
| - **TDMS**: new in this release. Auto-detected from `.tdms`. Detection is also fully client-side and maps TDMS groups and channels onto Sift channels. |
Contributor
There was a problem hiding this comment.
I think it's less important to mention that it all happens client side, and more important to mention the different import options for TDMS.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Bumps sift-stack-py to v0.14.0. Data import API now fully available in sift_client (CSV/Parquet/TDMS/HDF5), Parquet added as an export output format, plus test result logging and progress indicators. See the CHANGELOG for the full list of changes.