Merge pull request #14 from sot/discontinue-package

Discontinue package
sot · Dec 6, 2023 · df0d5b6 · df0d5b6
2 parents 5f6f2e7 + 3b630c6
commit df0d5b6
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,9 @@
 :mod:`ska_parsecm`
 ========================
 
+.. Warning:: the ska_parsecm package is **discontinued and no longer supported**.
+    Instead use `parse_cm <https://sot.github.io/parse_cm/>`.
+
+
 .. automodule:: ska_parsecm.ParseCM
    :members:
diff --git a/ska_parsecm/__init__.py b/ska_parsecm/__init__.py
@@ -1,4 +1,22 @@
 # Licensed under a 3-clause BSD style license - see LICENSE.rst
+import os
+import warnings
+
+message_warn = (
+    "\n"
+    "The ska_parsecm package is no longer supported and is replaced\n"
+    "by parse_cm. Please update your code accordingly.\n"
+)
+message_error = (
+    "\n"
+    "To temporarily continue using this package set the environment variable\n"
+    "SKA_ALLOW_DISCONTINUED_PACKAGES=1"
+)
+
+if os.environ.get("SKA_ALLOW_DISCONTINUED_PACKAGES") == "1":
+    warnings.warn(message_warn, FutureWarning)
+else:
+    raise RuntimeError(message_warn + message_error)
 
 import ska_helpers