Deprecate the codebasin package

The codebasin package was not originally designed for downstream users: the interface is undocumented, and in many cases is not very user-friendly. Semantic versioning recommends that there be at least one minor release with a deprecation warning prior to removing functionality in a major release. Deprecating the entire package is a simple solution that accurately communicates our intent to users. Signed-off-by: John Pennycook <[email protected]>
intel · Jan 30, 2024 · cdf2261 · cdf2261
1 parent 71cef77
commit cdf2261
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,
+)