From 4d4886755e6b7ac5669ee9a36532ac8266733d5c Mon Sep 17 00:00:00 2001 From: bruno-f-cruz <7049351+bruno-f-cruz@users.noreply.github.com> Date: Thu, 27 Aug 2026 09:16:18 -0700 Subject: [PATCH 1/5] Add deprecation notice to package and readme --- README.md | 6 ++++++ harp/__init__.py | 9 +++++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index 3f7b4bd..82f7846 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/harp/__init__.py b/harp/__init__.py index ba6211c..ef7732a 100644 --- a/harp/__init__.py +++ b/harp/__init__.py @@ -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 From 7ae769b9c117e0f6f0d926835ef985ebaea5051a Mon Sep 17 00:00:00 2001 From: bruno-f-cruz <7049351+bruno-f-cruz@users.noreply.github.com> Date: Wed, 21 Oct 2026 08:48:48 -0700 Subject: [PATCH 2/5] Add metadata --- pyproject.toml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index c8fcaac..b6bd1ad 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "harp-python" authors = [ {name = "Goncalo Lopes", email = "g.lopes@neurogears.org"} ] -description = "A low-level interface for loading binary Harp protocol data" +description = "[DEPRECATED] Superseded by harp-data (https://github.com/harp-tech/python). A low-level interface for loading binary Harp protocol data" readme = "README.md" requires-python = ">=3.9.0" dynamic = ["version"] @@ -15,7 +15,7 @@ dependencies = [ ] classifiers = [ - "Development Status :: 4 - Beta", + "Development Status :: 7 - Inactive", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.9", @@ -26,6 +26,8 @@ classifiers = [ [project.urls] "Bug Tracker" = "https://github.com/harp-tech/harp-python/issues" "Source Code" = "https://github.com/harp-tech/harp-python" +"Replacement" = "https://github.com/harp-tech/python" +"Migration Guide" = "https://harp-tech.org/python/articles/harp-python-migration/" [project.optional-dependencies] dev = [ From 8240f635ef95103c5182aeba4455e10c87c3b906 Mon Sep 17 00:00:00 2001 From: bruno-f-cruz <7049351+bruno-f-cruz@users.noreply.github.com> Date: Wed, 21 Oct 2026 08:54:39 -0700 Subject: [PATCH 3/5] Fix name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 82f7846..d15d8b2 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ > [!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. +> Please migrate to the new [`harp.data`](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). From 2cc1877448b42f503d8b85e12aac3037df011cb9 Mon Sep 17 00:00:00 2001 From: bruno-f-cruz <7049351+bruno-f-cruz@users.noreply.github.com> Date: Wed, 21 Oct 2026 09:11:57 -0700 Subject: [PATCH 4/5] Pin old linux version to get CICD to pass --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c2ea3b5..60980cd 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -15,7 +15,7 @@ jobs: if: github.event.pull_request.draft == false strategy: matrix: - os: [ubuntu-latest, windows-latest, macos-latest] + os: [ubuntu-24.04, windows-latest, macos-latest] python-version: [3.9, 3.12] fail-fast: false steps: From e8385d2f1bddae7abc2b1fb237d0801d32e5600f Mon Sep 17 00:00:00 2001 From: glopesdev Date: Wed, 21 Oct 2026 23:17:23 +0100 Subject: [PATCH 5/5] Point deprecation notice at the Harp Python docs Remove the import-time warning, so the deprecation is carried by the README notice and the package metadata. The notice now names the harp-data package, and the notice, description and replacement URL link the Harp Python documentation rather than the repository. --- README.md | 4 ++-- harp/__init__.py | 9 --------- pyproject.toml | 4 ++-- 3 files changed, 4 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d15d8b2..436ca23 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ > [!WARNING] > **This package is deprecated and will no longer receive updates.** > -> Please migrate to the new [`harp.data`](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. +> Please migrate to the new `harp-data` package from [Harp Python](https://harp-tech.org/python/), which supersedes this one with an improved API and continued support. +> A [migration guide](https://harp-tech.org/python/articles/harp-python-migration/) covers the transition. A low-level interface to data collected with the [Harp binary protocol](https://harp-tech.org/protocol/BinaryProtocol-8bit.html). diff --git a/harp/__init__.py b/harp/__init__.py index ef7732a..ba6211c 100644 --- a/harp/__init__.py +++ b/harp/__init__.py @@ -1,12 +1,3 @@ -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 diff --git a/pyproject.toml b/pyproject.toml index b6bd1ad..878366d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "harp-python" authors = [ {name = "Goncalo Lopes", email = "g.lopes@neurogears.org"} ] -description = "[DEPRECATED] Superseded by harp-data (https://github.com/harp-tech/python). A low-level interface for loading binary Harp protocol data" +description = "[DEPRECATED] Superseded by harp-data (https://harp-tech.org/python/). A low-level interface for loading binary Harp protocol data" readme = "README.md" requires-python = ">=3.9.0" dynamic = ["version"] @@ -26,7 +26,7 @@ classifiers = [ [project.urls] "Bug Tracker" = "https://github.com/harp-tech/harp-python/issues" "Source Code" = "https://github.com/harp-tech/harp-python" -"Replacement" = "https://github.com/harp-tech/python" +"Replacement" = "https://harp-tech.org/python/" "Migration Guide" = "https://harp-tech.org/python/articles/harp-python-migration/" [project.optional-dependencies]