From e6bf8e2ff13c166cee9a2e9fc79da98800b29413 Mon Sep 17 00:00:00 2001
From: willGraham01 <1willgraham@gmail.com>
Date: Wed, 1 Nov 2023 11:05:33 +0000
Subject: [PATCH] Mark as deprecated and add import warning

---
 README.md                    | 8 ++++++++
 brainreg_segment/__init__.py | 7 +++++++
 tox.ini                      | 2 +-
 3 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 22011dd..6a52214 100644
--- 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
index 653a478..b7f0eb4 100644
--- 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
index cab063d..20f363d 100644
--- 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