Prepare for migration (#261)

* Throw deprecation warning on import

* Update README with migration warning

* Force dependencies <1.0.0 of brainglobe packages

* Tell tox to ignore our own deprecation warning

* Update cellfinder/__init__.py

Co-authored-by: Alessandro Felder <alessandrofelder@users.noreply.github.com>

---------

Co-authored-by: Alessandro Felder <alessandrofelder@users.noreply.github.com>

README.md

@@ -1,3 +1,12 @@
+# Cellfinder has moved!
+
+As part of [our BrainGlobe version 1 update](https://brainglobe.info/blog/version1/version_1_announcement.html), the `cellfinder` workflow that can be run from the command line [has moved into `brainglobe-workflows`](https://github.com/brainglobe/brainglobe-workflows).
+Please head over to that package to install an up-to-date version of `cellfinder`.
+
+You can keep up to date with the version 1 rollout by [visiting our blog page](https://brainglobe.info/blog/index.html), or joining us [over on Zulip](https://brainglobe.zulipchat.com).
+
+---
+
 [![Python Version](https://img.shields.io/pypi/pyversions/cellfinder.svg)](https://pypi.org/project/cellfinder)
 [![PyPI](https://img.shields.io/pypi/v/cellfinder.svg)](https://pypi.org/project/cellfinder)
 [![Downloads](https://pepy.tech/badge/cellfinder)](https://pepy.tech/project/cellfinder)

cellfinder/__init__.py

@@ -1,3 +1,10 @@
+import warnings
+
+warnings.warn(
+    "cellfinder (the command line tool) has migrated. Please use brainglobe-workflows instead: https://github.com/brainglobe/brainglobe-workflows",
+    DeprecationWarning,
+)
+
 from importlib.metadata import metadata
 
 __version__ = metadata("cellfinder")["version"]

pyproject.toml

@@ -23,11 +23,11 @@ classifiers = [
 ]
 dependencies = [
     "brainreg>=1.0.0",
-    "cellfinder-core>=0.2.4",
+    "cellfinder-core>=0.2.4,<1.0.0",
     "configobj",
     "fancylog>=0.0.7",
     "imio",
-    "brainglobe-utils>=0.2.5",
+    "brainglobe-utils>=0.2.5,<1.0.0",
     "multiprocessing-logging>=0.3.4",
     "natsort",
     "numpy",
@@ -52,7 +52,11 @@ dev = [
     "pre-commit",
     "setuptools_scm",
 ]
-napari = ["napari[pyside2]", "brainglobe-napari-io", "cellfinder-napari"]
+napari = [
+    "napari[pyside2]",
+    "brainglobe-napari-io<1.0.0",
+    "cellfinder-napari<1.0.0",
+]
 
 [project.urls]
 source = "https://github.com/brainglobe/cellfinder"

tox.ini

@@ -14,7 +14,7 @@ INPUT_COREDEV =
     true: coredev
 
 [testenv]
-commands = pytest {toxinidir} -v --cov=./ --cov-report=xml
+commands = pytest {toxinidir} -v --cov=./ --cov-report=xml -W ignore::DeprecationWarning
 deps =
     pytest-cov
     pytest