Relaxed validation in capture listing: capture listing is now more tolerant of cases where a given capture fails validation, now listing the ones that can be loaded correctly instead of failing the whole operations. Container fields like files now also default to empty ones if missing, instead of failing validation.
0.1.15 - 2025-12-02
Features:
Added support for Python 3.14: the SDK is now compatible with Python 3.14. We're thus dropping support for version 3.10 in this and future releases.
Discovery step lists all files before starting upload.
Concurrent uploads with asyncio: up to 5 streams by default.
Progress tracking the number of files and bytes, in human-friendly units.
Tracking completed :white_check_mark:, failed :x: , in progress :hourglass_flowing_sand:️ and skipped:rabbit2: files. On Windows, we use ASCII characters for better compatibility.
This makes resuming interrupted uploads faster. The persistence mode can be bypassed with persist_state=False in upload methods in case users want to force the file checks (previous behavior).
Reliability:
Increased the battery of tests for file uploads and progress tracking.
Several new tests covering features of upload state persistence.
Added download_dataset method to client: Users can now download datasets through the SDK by passing in a dataset UUID e.g. sds_client.download_dataset(uuid=<dataset_uuid>, to_local_path=...).
Capture deletions: captures may now be deleted using the SDK with sds_client.captures.delete().
Advanced searches: introducing preliminary support for advanced capture searches using OpenSearch queries. See the OpenSearch Query Tips for details about the syntax. The SDK endpoint is sds_client.captures.advanced_search(): the method's docstring has information on arguments and links to documentation.
Usage improvements:
Allowing positional args: SDK methods that receive a single UUID as an argument now allow it to be passed as a positional argument e.g. sds_client.get_file(<uuid>) is equivalent to sds_client.get_file(uuid=<uuid>).
Capture uploads: new high-level method that combines the upload of a directory of files with a capture creation: sds_client.upload_capture().
Usage guide updates: the SDK usage guide now includes information on how to check the results returned by a directory upload.
Logging control:: client's verbose flag propagates to submodules and sub-APIs.
Bugfixes and reliability improvements:
Bugfix:File.local_path attribute of some downloaded files was not correctly set.
Path usage tests:: new tests to cover regressions of different ways to use paths from SDK methods.
Capture read test: tests for client.capture.read() now check the number of files associated to the capture is correct.
#78 The capture_type argument of sds_client.captures.listing() is now optional.
#78 The method sds_client.captures.read() is now available for reading a single capture, complementing the existing sds_client.captures.listing() method.
#78 When retrieving a single capture with capture = read(<uuid>), the list of files associated to it is available in capture.files.
Note these are CaptureFile instances, which hold a subset of the information in an SDS' File instance. To get all metadata on a file, use sds_client.get_file(<uuid>).
Fixes:
#77 Fixed incorrect file name being set when the file contents are already in SDS.
#77local_path is now set for uploaded files across all three upload modes.
#71 File permissions are now included in file uploads; redesigned handling of permission flags.
Housekeeping:
#76 Fixed documentation typos; Updated and expanded note on concurrent access in the usage guide.
0.1.7 - 2025-03-07
Features:
spectrumx.api.captures.create() now accepts a scan_group for RadioHound captures.
index_name from spectrumx.api.captures.create() is dropped: the index is automatically chosen from the capture type.
0.1.6 - 2025-02-24
New features:
Support for Python 3.10 and 3.11.
0.1.5 - 2025-02-10
Breaking changes:
spectrumx.models.File moved to spectrumx.models.files.File.
New features:
SDS Capture creation and listing.
Housekeeping:
Refactored client by branching its method implementations and client configuration to separate modules.
0.1.4 - 2025-01-17
New features:
File listing with lazy-loaded paginated results.
Introduced new file upload modes to avoid re-uploading files already in SDS.
Housekeeping:
Usage documentation updated.
See tests/e2e_examples/check_build_acceptance.py for more SDK usage examples.