diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e3621d..31809a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,3 @@ -## 0.0.2 +## 0.1.0 -* added access to raw microphone dataframes -* added a dedicated `docs/` documentation set (getting started, data model, API reference) -* updated `README.md` as a concise entry point and linked full docs - -## 0.0.1 - -* Initial release of the Open Earable Python SDK. -* parse Open Earable data files +* Initial release of the Open Wearable Python SDK. diff --git a/README.md b/README.md index c3d8953..ad8cb22 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# Open Earable Python +# Open Wearable Python toolkit for parsing and analyzing multi-sensor OpenEarable recordings. ## Installation ```bash -pip install open-earable-python +pip install open-wearable ``` For local development: @@ -21,7 +21,7 @@ pip install -e . ## Quick Example ```python -from open_earable_python import SensorDataset +from open_wearable import SensorDataset dataset = SensorDataset("recording.oe") diff --git a/docs/README.md b/docs/README.md index 52001eb..ce82628 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ -# Open Earable Python Documentation +# Open Wearable Documentation -`open-earable-python` parses `.oe` recordings into pandas DataFrames and exposes convenient accessors for OpenEarable sensor streams. +`open-wearable` parses `.oe` recordings into pandas DataFrames and exposes convenient accessors for OpenEarable sensor streams. ## Contents diff --git a/docs/api-reference.md b/docs/api-reference.md index d62c9cc..69ae058 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -3,7 +3,7 @@ ## Package Exports ```python -from open_earable_python import SensorDataset, load_recordings +from open_wearable import SensorDataset, load_recordings ``` ## `SensorDataset` @@ -102,7 +102,7 @@ load_recordings(file_paths: Sequence[str]) -> List[SensorDataset] Creates `SensorDataset` objects for existing files only. -## Parser Module (`open_earable_python.parser`) +## Parser Module (`open_wearable.parser`) Core classes and helpers for decoding binary packets: @@ -114,7 +114,7 @@ Core classes and helpers for decoding binary packets: - `interleaved_mic_to_stereo(samples)`: converts interleaved samples to stereo. - `mic_packet_to_stereo_frames(packet, sampling_rate)`: timestamp + stereo frame conversion. -## Scheme Module (`open_earable_python.scheme`) +## Scheme Module (`open_wearable.scheme`) Defines sensor schema primitives: diff --git a/docs/getting-started.md b/docs/getting-started.md index d5eeb31..fdba19e 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -8,7 +8,7 @@ ## Installation ```bash -pip install open-earable-python +pip install open-wearable ``` From source: @@ -24,7 +24,7 @@ pip install -e . ## Load a Recording ```python -from open_earable_python import SensorDataset +from open_wearable import SensorDataset dataset = SensorDataset("my_recording.oe") ``` @@ -88,7 +88,7 @@ dataset.save_csv("recording.csv") ## Load Multiple Files ```python -from open_earable_python import load_recordings +from open_wearable import load_recordings recordings = load_recordings(["session1.oe", "session2.oe"]) for rec in recordings: diff --git a/pyproject.toml b/pyproject.toml index d5ecd0f..a1c6e8e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=80", "setuptools-scm[toml]>=8"] build-backend = "setuptools.build_meta" [project] -name = "open-earable-python" +name = "open-wearable" dynamic = ["version"] description = "Reader and utilities for multi-sensor OpenEarable recordings." readme = "README.md" diff --git a/src/open_earable_python/__init__.py b/src/open_wearable/__init__.py similarity index 100% rename from src/open_earable_python/__init__.py rename to src/open_wearable/__init__.py diff --git a/src/open_earable_python/dataset.py b/src/open_wearable/dataset.py similarity index 99% rename from src/open_earable_python/dataset.py rename to src/open_wearable/dataset.py index ba6e1c6..f88f868 100644 --- a/src/open_earable_python/dataset.py +++ b/src/open_wearable/dataset.py @@ -5,8 +5,8 @@ import numpy as np import pandas as pd -from open_earable_python import parser -import open_earable_python.scheme as scheme +from open_wearable import parser +import open_wearable.scheme as scheme from IPython.display import Audio, display from scipy.io.wavfile import write diff --git a/src/open_earable_python/parser.py b/src/open_wearable/parser.py similarity index 99% rename from src/open_earable_python/parser.py rename to src/open_wearable/parser.py index 507bd1f..b0aa310 100644 --- a/src/open_earable_python/parser.py +++ b/src/open_wearable/parser.py @@ -1,5 +1,5 @@ import struct -from open_earable_python.scheme import SensorScheme, ParseType +from open_wearable.scheme import SensorScheme, ParseType import pandas as pd from typing import BinaryIO, Dict, List, Optional, Tuple, TypedDict, Union from dataclasses import dataclass, field diff --git a/src/open_earable_python/scheme.py b/src/open_wearable/scheme.py similarity index 100% rename from src/open_earable_python/scheme.py rename to src/open_wearable/scheme.py