Skip to content

Deprecate package in favor of the new harp-data #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bruno-f-cruz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Deprecate package in favor of the new harp-data #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# harp-python

> [!WARNING]
> **This package is deprecated and will no longer receive updates.**
>
> Please migrate to the new [`harp-python`](https://github.com/harp-tech/python) package, which supersedes this one with an improved API and continued support.
> A [migration guide](https://harp-tech.org/python/articles/harp-python-migration/) is available to help you transition.

A low-level interface to data collected with the [Harp binary protocol](https://harp-tech.org/protocol/BinaryProtocol-8bit.html).

## How to install
Expand Down
9 changes: 9 additions & 0 deletions harp/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
import warnings

warnings.warn(
"The 'harp-python' package is deprecated and will no longer receive updates. "
"Please migrate to the new 'harp-data' package: pip install harp-data",
DeprecationWarning,
stacklevel=2,
)

from harp.io import REFERENCE_EPOCH, MessageType, read, to_buffer, to_file
from harp.reader import create_reader
from harp.schema import read_schema
Expand Down
Loading