Merge pull request #742 from bespokelabsai/codex/shared-bespokelabs-namespace

Fix shared namespace packaging for Curator and sibling SDKs

Author: mahesh-bespoke

README.md

@@ -56,6 +56,28 @@ Check out our full documentation for [getting started](https://docs.bespokelabs.
 ```bash
 pip install bespokelabs-curator
 ```
+
+Curator and Sandbox share the `bespokelabs` import namespace:
+
+```bash
+python -m pip install bespokelabs-curator bespokelabs-sandbox
+```
+
+```python
+from bespokelabs import curator, sandbox
+```
+
+The separate `bespokelabs` distribution is not required. The Nimble SDK's
+distribution is `bespokelabs-nimble`. Each project must own only its subpackage
+(`bespokelabs/curator`, `bespokelabs/sandbox`, or `bespokelabs/nimble`), leaving
+the shared `bespokelabs` directory without an `__init__.py`.
+
+When upgrading from releases that installed that shared file, use a fresh virtual
+environment and run `python -m pip` with the Python interpreter used by your app
+or notebook. Old editable checkouts or a local `bespokelabs.py` can shadow the
+installed namespace. A traceback naming a dependency inside Curator indicates a
+dependency failure; changing the package name alone will not fix it.
+
 ## 📕 Examples
 
 ### Finetuning/Distillation

poetry.lock

@@ -5,7 +5,7 @@ description = "Bespoke Labs Curator"
 authors = ["Bespoke Labs <company@bespokelabs.ai>"]
 readme = "README.md"
 packages = [
-    {include = "bespokelabs", from = "src"},
+    {include = "bespokelabs/curator", from = "src"},
 ]
 include = [
     "src/bespokelabs/curator/viewer/static/**/*"
@@ -35,7 +35,7 @@ aiofiles = ">=22.0,<26.0"
 anthropic = "^0.84.0"
 vertexai = "1.71.1"
 vllm = { version = "^0.6.3", optional = true }
-bespokelabs-sandbox = "0.1.1"
+bespokelabs-sandbox = ">=0.1.1,<0.2.0"
 tinker = { version = "^0.8.0", optional = true, python = ">=3.11" }
 
 posthog = "^3.11.0"

pyproject.toml

@@ -0,0 +1,31 @@
+"""Check that a source install can share its namespace with another project."""
+
+import subprocess
+import sys
+from pathlib import Path
+
+import pytest
+
+
+@pytest.mark.parametrize("source_first", [True, False])
+def test_separate_namespace_portions(tmp_path: Path, source_first: bool):
+    source = Path(__file__).resolve().parents[2] / "src"
+    sibling = tmp_path / "other-project"
+    package = sibling / "bespokelabs" / "namespace_probe"
+    package.mkdir(parents=True)
+    (package / "__init__.py").write_text("VALUE = 42\n")
+    paths = [str(source), str(sibling)]
+    if not source_first:
+        paths.reverse()
+    code = f"""
+import sys
+from importlib.util import find_spec
+sys.path[:0] = {paths!r}
+from bespokelabs import namespace_probe
+import bespokelabs
+assert namespace_probe.VALUE == 42
+assert bespokelabs.__file__ is None
+assert find_spec('bespokelabs.curator').origin == {str(source / 'bespokelabs/curator/__init__.py')!r}
+"""
+    # Disable site-packages so installed siblings cannot mask the source layout.
+    subprocess.run([sys.executable, "-I", "-S", "-c", code], check=True, capture_output=True, text=True)