Merge pull request #40 from Pennycook/package-deprecation

Deprecate the codebasin package
intel · Feb 5, 2024 · eaa78bf · eaa78bf
2 parents 71cef77 + cdf2261
commit eaa78bf
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/codebasin/__init__.py b/codebasin/__init__.py
@@ -1,3 +1,13 @@
 # Copyright (C) 2019-2024 Intel Corporation
 # SPDX-License-Identifier: BSD-3-Clause
+import warnings
+
 import codebasin.walkers
+
+warnings.warn(
+    "Calling codebasin package internals is deprecated. "
+    + "Please call the codebasin script directly instead. "
+    + "A new, stable, package interface will be introduced in "
+    + "a future release of Code Base Investigator.",
+    DeprecationWarning,
+)