Mark as deprecated and add import warning (#140)

brainglobe · Nov 6, 2023 · 04bc1a2 · 04bc1a2
1 parent 5ac5dc4
commit 04bc1a2
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,11 @@
+# This package is deprecated!
+
+Please use [`brainglobe-segmentation` instead](https://github.com/brainglobe/brainglobe-segmentation).
+
+The old README can be found below.
+
+---
+
 [![Python Version](https://img.shields.io/pypi/pyversions/brainreg-segment.svg)](https://pypi.org/project/brainreg-segment)
 [![PyPI](https://img.shields.io/pypi/v/brainreg-segment.svg)](https://pypi.org/project/brainreg-segment)
 [![Wheel](https://img.shields.io/pypi/wheel/brainreg-segment.svg)](https://pypi.org/project/brainreg-segment)

diff --git a/brainreg_segment/__init__.py b/brainreg_segment/__init__.py
@@ -1,3 +1,10 @@
+import warnings
+
+warnings.warn(
+    "brainreg-segment is deprecated. Please use brainglobe-segmentation instead: https://github.com/brainglobe/brainglobe-segmentation",
+    DeprecationWarning,
+)
+
 from importlib.metadata import PackageNotFoundError, version
 from . import *
 

diff --git a/tox.ini b/tox.ini
@@ -25,4 +25,4 @@ deps =
     pyqt5
     magicgui
 
-commands = pytest -v --color=yes --cov=brainreg_segment --cov-report=xml
+commands = pytest -v --color=yes --cov=brainreg_segment --cov-report=xml -W ignore::DeprecationWarning