This project has been archived by its maintainers, and is no longer receiving any updates.
harp-python
A low-level interface to data collected with the Harp binary protocol.
How to install
The source code is currently hosted on GitHub.
Binary installers for the latest released version are available at the Python Package Index (PyPI) and can be installed using pip.
pip install harp-python
The list of changes between each release can be found here.
Data model
The interface makes use of a Pydantic data model generated from Harp device schema definitions. The schema data classes are used to automatically generate binary readers for each device.
All binary data files from a single device need to be stored in the same folder alongside the device meta-schema, named device.yml. Each register file should have the following naming convention <deviceName>_<registerAddress>.bin.
For example, for a dataset collected with a Behavior device, you might have:
📦device.harp
┣ 📜Behavior_0.bin
┣ 📜Behavior_1.bin
...
┗ 📜device.yml
How to use
Create device reader object from schema
import harp
reader = harp.create_reader("device.harp")
Read data from named register
reader.OperationControl.read()
Access register metadata
reader.OperationControl.register.address
Create device reader object with UTC datetime format
reader = harp.create_reader("device.harp", epoch=harp.REFERENCE_EPOCH)
Read data with message type information
reader.OperationControl.read(keep_type=True)
Read data from a specific file
reader.OperationControl.read("data/Behavior_10.bin")
Metadata
Release files for harp-python 0.4.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| harp_python-0.4.2.tar.gz | 16.4 kB | Without provenance | Details for harp_python-0.4.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| harp_python-0.4.2-py3-none-any.whl | Python 3 | none | any | Details for harp_python-0.4.2-py3-none-any.whl |
Total release size: 29.3 kB
Release files / harp_python-0.4.2.tar.gz
| Download URL | harp_python-0.4.2.tar.gz |
|---|---|
| Size | 16.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a5d6d5fb8dc00244dc9bb26759cd32d288e2999782bc5ebcf8e6351e2dc320c6
|
|
BLAKE2b-256 checksum How to use checksums |
58b5e73c12f444f1d9bbbc3ed4955e02fe174ce10b647fe9d3c7b6d04f7b0185
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / harp_python-0.4.2-py3-none-any.whl
| Download URL | harp_python-0.4.2-py3-none-any.whl |
|---|---|
| Size | 12.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
36902d9f47b5b90e9314e408f03b9ef1bca017cd04160f84c408435e919c6f60
|
|
BLAKE2b-256 checksum How to use checksums |
c2290480975860879ac4afb2149c2b23af337810df93c9901c8628149ebc7b65
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for harp-python 0.4.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.