Prepare for merge and rename (#198)

* Add package moved to README * Flag deprecation in import
brainglobe · Feb 20, 2024 · 9d5317d · 9d5317d
1 parent cbb1794
commit 9d5317d
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,8 @@
+# This package has moved!
+
+This package has been renamed to `brainglobe-atlasapi`.
+To continue receiving updates, please switch over to using [the new package](https://github.com/brainglobe/brainglobe-atlasapi).
+
 # BG-atlasAPI
 
 [![Python Version](https://img.shields.io/pypi/pyversions/bg-atlasapi.svg)](https://pypi.org/project/bg-atlasapi)

diff --git a/bg_atlasapi/__init__.py b/bg_atlasapi/__init__.py
@@ -1,3 +1,12 @@
+from warnings import warn
+
+warn(
+    "This package has been renamed. "
+    "To continue receiving updates, please use brainglobe-atlasapi instead of this package. "
+    "https://github.com/brainglobe/brainglobe-atlasapi",
+    DeprecationWarning,
+)
+
 from importlib.metadata import PackageNotFoundError, metadata
 
 try:

diff --git a/pyproject.toml b/pyproject.toml
@@ -96,5 +96,5 @@ python =
 [testenv]
 extras =
     dev
-commands = pytest -v --color=yes --cov=bg_atlasapi --cov-report=xml
+commands = pytest -v --color=yes --cov=bg_atlasapi --cov-report=xml -W ignore::DeprecationWarning
 """