syncfield 0.1.0__tar.gz

syncfield-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: python -m pip install --upgrade pip build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

syncfield-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]" || pip install -e . && pip install pytest
+
+      - name: Run tests
+        run: pytest -v

syncfield-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+# Python
+__pycache__/
+*.py[cod]
+*.so
+
+# Distribution / Packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db

syncfield-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 OpenGraph Labs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

syncfield-0.1.0/PKG-INFO

@@ -0,0 +1,405 @@
+Metadata-Version: 2.4
+Name: syncfield
+Version: 0.1.0
+Summary: Lightweight timestamp capture SDK for SyncField multi-stream synchronization
+Project-URL: Homepage, https://opengraphlabs.com/
+Project-URL: Repository, https://github.com/OpenGraphLabs/syncfield-python
+Project-URL: Documentation, https://github.com/OpenGraphLabs/syncfield-python#readme
+Project-URL: Issues, https://github.com/OpenGraphLabs/syncfield-python/issues
+Author: OpenGraph Labs
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: data-collection,multi-camera,robotics,synchronization,timestamp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# syncfield-python
+
+Lightweight Python SDK for [SyncField](https://opengraphlabs.com) multi-stream synchronization. Captures precise timestamps during multi-camera and sensor recording and produces JSONL files that the SyncField Docker service consumes for frame-level temporal alignment.
+
+## Install
+
+```bash
+pip install syncfield
+```
+
+**Zero dependencies** -- uses only the Python standard library.
+
+## Quick Start
+
+### Video Streams
+
+Use `stamp()` to capture timestamps and `link()` to associate the saved video file with the stream.
+
+```python
+import syncfield as sf
+
+session = sf.SyncSession(host_id="rig_01", output_dir="./sync_data")
+session.start()
+
+for i in range(num_frames):
+    frame = camera.read()
+    session.stamp("cam_left", frame_number=i)
+    save_frame_to_video(frame, "cam_left.mp4")
+
+session.link("cam_left", "/data/cam_left.mp4")
+session.stop()
+```
+
+Output:
+```
+./sync_data/
+  sync_point.json
+  cam_left.timestamps.jsonl
+  manifest.json
+```
+
+### Sensor Streams
+
+Use `record()` to capture timestamps and sensor data in one call. This writes both a `.timestamps.jsonl` file (for alignment) and a `.jsonl` file (sensor channel values).
+
+```python
+import syncfield as sf
+
+session = sf.SyncSession(host_id="rig_01", output_dir="./sync_data")
+session.start()
+
+for i in range(num_samples):
+    data = imu.read()
+    session.record("imu", frame_number=i, channels={
+        "accel_x": data.ax,
+        "accel_y": data.ay,
+        "accel_z": data.az,
+    })
+
+session.stop()
+```
+
+Output:
+```
+./sync_data/
+  sync_point.json
+  imu.timestamps.jsonl
+  imu.jsonl
+  manifest.json
+```
+
+### Multi-Stream Example
+
+A complete example with 2 cameras and 1 IMU, each in its own thread.
+
+```python
+import threading
+import syncfield as sf
+
+session = sf.SyncSession(host_id="rig_01", output_dir="./sync_data")
+session.start()
+
+recording = True
+
+def camera_loop(cam, stream_id, video_path):
+    i = 0
+    while recording:
+        frame = cam.read()
+        session.stamp(stream_id, frame_number=i)
+        save_frame(frame, video_path)
+        i += 1
+    session.link(stream_id, video_path)
+
+def imu_loop(imu, stream_id):
+    i = 0
+    while recording:
+        data = imu.read()
+        session.record(stream_id, frame_number=i, channels={
+            "accel_x": data.ax, "accel_y": data.ay, "accel_z": data.az,
+            "gyro_x": data.gx, "gyro_y": data.gy, "gyro_z": data.gz,
+        })
+        i += 1
+
+threads = [
+    threading.Thread(target=camera_loop, args=(cam_left, "cam_left", "/data/cam_left.mp4")),
+    threading.Thread(target=camera_loop, args=(cam_right, "cam_right", "/data/cam_right.mp4")),
+    threading.Thread(target=imu_loop, args=(imu_device, "imu")),
+]
+
+for t in threads:
+    t.start()
+
+# ... record for desired duration ...
+recording = False
+
+for t in threads:
+    t.join()
+
+counts = session.stop()
+# counts == {"cam_left": 900, "cam_right": 900, "imu": 9000}
+```
+
+Output directory:
+```
+./sync_data/
+  sync_point.json
+  cam_left.timestamps.jsonl
+  cam_right.timestamps.jsonl
+  imu.timestamps.jsonl
+  imu.jsonl
+  manifest.json
+```
+
+## Best Practices
+
+### Call `stamp()`/`record()` immediately after I/O read
+
+The timestamp should reflect when data arrived on the host, not when processing finished.
+
+```python
+# GOOD -- timestamp reflects when data arrived on the host
+data = device.read()
+session.stamp("sensor", frame_number=i)  # immediately after read
+
+# BAD -- processing delay adds jitter to timestamp
+data = device.read()
+processed = expensive_transform(data)
+session.stamp("sensor", frame_number=i)  # too late!
+```
+
+### Use one thread per device
+
+Each device should have its own thread with a tight read loop. Both `stamp()` and `record()` are thread-safe.
+
+```python
+import threading
+
+def camera_thread(cam, stream_id, session):
+    i = 0
+    while recording:
+        frame = cam.read()
+        session.stamp(stream_id, frame_number=i)
+        i += 1
+
+def sensor_thread(imu, stream_id, session):
+    i = 0
+    while recording:
+        data = imu.read()
+        session.record(stream_id, frame_number=i, channels={
+            "accel_x": data.ax, "accel_y": data.ay, "accel_z": data.az,
+        })
+        i += 1
+
+t1 = threading.Thread(target=camera_thread, args=(camera, "cam_left", session))
+t2 = threading.Thread(target=sensor_thread, args=(imu_device, "imu", session))
+t1.start()
+t2.start()
+```
+
+## Integration with SyncField Docker
+
+### Using `manifest.json` (recommended)
+
+After `stop()`, the SDK writes a `manifest.json` that maps all streams to their files. Use it to construct the API request body programmatically.
+
+```python
+import json
+import requests
+
+# Read the manifest produced by the SDK
+with open("./sync_data/manifest.json") as f:
+    manifest = json.load(f)
+
+host_id = manifest["host_id"]
+
+# Build the streams list from manifest entries
+streams = []
+for stream_id, info in manifest["streams"].items():
+    stream_entry = {"stream_id": stream_id}
+
+    if "path" in info:
+        stream_entry["path"] = info["path"]
+
+    if info.get("type") == "sensor":
+        stream_entry["stream_type"] = "sensor"
+
+    streams.append(stream_entry)
+
+# Mark the first video stream as primary
+for s in streams:
+    entry = manifest["streams"][s["stream_id"]]
+    if entry.get("type") == "video":
+        s["is_primary"] = True
+        break
+
+# Submit to SyncField Docker
+resp = requests.post("http://localhost:8080/api/v1/sync", json={
+    "hosts": [
+        {
+            "host_id": host_id,
+            "streams": streams,
+        }
+    ],
+    "timestamps_dir": "/timestamps",
+})
+print(resp.json())  # {"job_id": "a1b2c3d4"}
+```
+
+### Volume-mounted mode
+
+Mount your data and timestamp directories into the container and call the API directly.
+
+```bash
+docker run -v ./data:/data -v ./sync_data:/timestamps \
+  syncfield-app:latest
+```
+
+```bash
+curl -X POST http://localhost:8080/api/v1/sync \
+  -H "Content-Type: application/json" \
+  -d '{
+    "hosts": [
+      {
+        "host_id": "rig_01",
+        "streams": [
+          {"path": "/data/cam_left.mp4", "stream_id": "cam_left", "is_primary": true},
+          {"path": "/data/cam_right.mp4", "stream_id": "cam_right"},
+          {"stream_id": "imu", "stream_type": "sensor"}
+        ]
+      }
+    ],
+    "timestamps_dir": "/timestamps"
+  }'
+```
+
+The service automatically matches `{stream_id}.timestamps.jsonl` and `{stream_id}.jsonl` files to streams using the `timestamps_dir` path.
+
+### File upload mode
+
+Upload files directly without volume mounts. Use `host_ids` to group streams by host.
+
+```python
+import requests
+
+files = [
+    ("files", open("cam_left.mp4", "rb")),
+    ("files", open("cam_right.mp4", "rb")),
+    ("timestamp_files", open("sync_data/cam_left.timestamps.jsonl", "rb")),
+    ("timestamp_files", open("sync_data/cam_right.timestamps.jsonl", "rb")),
+]
+data = {
+    "stream_ids": "cam_left,cam_right",
+    "host_ids": "rig_01,rig_01",
+    "primary_id": "cam_left",
+}
+resp = requests.post("http://localhost:8080/api/v1/sync/upload", files=files, data=data)
+print(resp.json())  # {"job_id": "a1b2c3d4"}
+```
+
+## Format Specification
+
+This section defines the output format for implementors in other languages.
+
+### `sync_point.json`
+
+```json
+{
+  "sdk_version": "0.1.0",
+  "monotonic_ns": 1234567890123456789,
+  "wall_clock_ns": 1709890101000000000,
+  "host_id": "rig_01",
+  "timestamp_ms": 1709890101000,
+  "iso_datetime": "2024-03-08T12:00:01.000000"
+}
+```
+
+### `{stream_id}.timestamps.jsonl`
+
+One JSON object per line (no trailing comma, no array wrapper):
+
+```jsonl
+{"frame_number":0,"capture_ns":1234567890123456789,"clock_source":"host_monotonic","clock_domain":"rig_01","uncertainty_ns":5000000}
+{"frame_number":1,"capture_ns":1234567890156789012,"clock_source":"host_monotonic","clock_domain":"rig_01","uncertainty_ns":5000000}
+```
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `frame_number` | int | 0-based sequential index |
+| `capture_ns` | int | Monotonic nanoseconds at data arrival |
+| `clock_source` | string | Always `"host_monotonic"` for SDK output |
+| `clock_domain` | string | Must match `host_id` -- identifies the clock |
+| `uncertainty_ns` | int | Timing uncertainty (default: 5000000 = 5ms) |
+
+**Key rules:**
+- `capture_ns` must be monotonically non-decreasing within each stream
+- `clock_domain` must be identical across all streams on the same host
+- File name must be `{stream_id}.timestamps.jsonl` for auto-matching
+
+### `{stream_id}.jsonl` (Sensor Data)
+
+One JSON object per line, combining timestamp and channel values:
+
+```jsonl
+{"frame_number":0,"capture_ns":1234567890123456789,"clock_source":"host_monotonic","clock_domain":"rig_01","uncertainty_ns":5000000,"channels":{"accel_x":0.12,"accel_y":-9.8,"accel_z":0.05}}
+{"frame_number":1,"capture_ns":1234567890133456789,"clock_source":"host_monotonic","clock_domain":"rig_01","uncertainty_ns":5000000,"channels":{"accel_x":0.13,"accel_y":-9.7,"accel_z":0.06}}
+```
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `frame_number` | int | 0-based sequential index |
+| `capture_ns` | int | Monotonic nanoseconds at data arrival (same clock as video timestamps) |
+| `clock_source` | string | Origin of the timestamp (always `"host_monotonic"` for SDK) |
+| `clock_domain` | string | Host identifier -- must match across all streams on the same host |
+| `uncertainty_ns` | int | Timing uncertainty (default: 5000000 = 5ms) |
+| `channels` | object | Sensor values as key-value pairs (e.g. `{"accel_x": 0.12}`) |
+
+### `manifest.json`
+
+Written by `stop()`. Maps all streams in the session to their output files.
+
+```json
+{
+  "sdk_version": "0.1.0",
+  "host_id": "rig_01",
+  "streams": {
+    "cam_left": {
+      "type": "video",
+      "timestamps_path": "cam_left.timestamps.jsonl",
+      "frame_count": 900,
+      "path": "/data/cam_left.mp4"
+    },
+    "cam_right": {
+      "type": "video",
+      "timestamps_path": "cam_right.timestamps.jsonl",
+      "frame_count": 900,
+      "path": "/data/cam_right.mp4"
+    },
+    "imu": {
+      "type": "sensor",
+      "sensor_path": "imu.jsonl",
+      "timestamps_path": "imu.timestamps.jsonl",
+      "frame_count": 9000
+    }
+  }
+}
+```
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `sdk_version` | string | SDK version that produced this file |
+| `host_id` | string | Host identifier for this recording session |
+| `streams` | object | Map of `stream_id` to stream metadata |
+| `streams.*.type` | string | `"video"` or `"sensor"` |
+| `streams.*.timestamps_path` | string | Relative path to the timestamps JSONL file |
+| `streams.*.frame_count` | int | Number of frames/samples recorded |
+| `streams.*.path` | string | (video only) Path set via `link()` |
+| `streams.*.sensor_path` | string | (sensor only) Relative path to the sensor data JSONL file |
+
+## License
+
+Apache-2.0