MSTR-Robotics-magerdaniel 0.5.6__tar.gz → 0.5.8__tar.gz

{mstr_robotics_magerdaniel-0.5.6 → mstr_robotics_magerdaniel-0.5.8}/MSTR_Robotics_magerdaniel.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MSTR-Robotics-magerdaniel
-Version: 0.5.6
+Version: 0.5.8
 Summary: Automation toolkit for MicroStrategy / Strategy One: object read-out, migration, comparison, RAG and OSI export.
 Author-email: Daniel Mager <danielmager@gmx.de>
 Requires-Python: >=3.12

{mstr_robotics_magerdaniel-0.5.6 → mstr_robotics_magerdaniel-0.5.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MSTR-Robotics-magerdaniel
-Version: 0.5.6
+Version: 0.5.8
 Summary: Automation toolkit for MicroStrategy / Strategy One: object read-out, migration, comparison, RAG and OSI export.
 Author-email: Daniel Mager <danielmager@gmx.de>
 Requires-Python: >=3.12

{mstr_robotics_magerdaniel-0.5.6 → mstr_robotics_magerdaniel-0.5.8}/mstr_robotics/__init__.py

@@ -4,4 +4,4 @@ Object read-out, migration packaging, environment comparison, RAG helpers
 and OSI dashboard export, driven by the Jupyter notebooks in ``notebooks/``.
 """
 
-__version__ = "0.5.6"
+__version__ = "0.5.8"

{mstr_robotics_magerdaniel-0.5.6 → mstr_robotics_magerdaniel-0.5.8}/mstr_robotics/_paths.py

@@ -1,11 +1,18 @@
-"""Central repo-relative path resolution.
-
-Every path here is derived from the installed package location
-(``Path(__file__).parent.parent`` == the repo root), so the same code resolves
-correctly in whichever environment the package is installed -- e.g.
-``mstr_robotics`` vs ``mstr_robotics_comp`` -- without any hardcoded absolute
-paths. This is what lets ``tools/nb_compare`` run the same notebooks against two
-environments and get comparable results.
+"""Central project-relative path resolution.
+
+Resolution walks up from the current working directory looking for
+``config/user_d.yml`` -- the marker that says "this is a project that has run
+setup". This is what lets a user ``pip install`` the package, copy the
+reference material from ``mstr_robotics/utils/`` to the top level of their own
+project, and have config/output/OSI paths resolve there -- instead of inside
+the installed package's own location (e.g. site-packages), which is not
+writable in any meaningful sense for the user.
+
+It is also what lets ``tools/nb_compare`` (in the dans_playground dev repo)
+run the same notebooks against two full repo checkouts that share one
+installed ``mstr_robotics`` package: each checkout has its own
+``config/user_d.yml``, so walking up from cwd tells the two apart even though
+``Path(__file__)`` cannot.
 
 Notebooks and modules should import the constants they need from here, e.g.::
 
@@ -20,34 +27,40 @@ from __future__ import annotations
 import os
 from pathlib import Path
 
-# Marker that identifies a repo root (every environment has its own copy).
-_MARKER = Path("config") / "user_d.yml"
+# Markers that identify a project root (every environment has its own copy).
+# ``user_d.yml`` exists once setup has run; ``user_d.example.yml`` exists as
+# soon as the user copies mstr_robotics/utils/config/ in, before setup has run
+# even once -- needed because the setup notebook itself runs from
+# <project>/notebooks/, one level below the project root it needs to find.
+_MARKERS = (
+    Path("config") / "user_d.yml",
+    Path("config") / "user_d.example.yml",
+)
 
 
 def find_repo_root() -> Path:
-    """Resolve the repo root of the *current* environment.
-
-    The two comparison environments (mstr_robotics / mstr_robotics_comp) share a
-    single installed ``mstr_robotics`` package, so ``Path(__file__)`` always
-    points at whichever repo the package was installed from -- it cannot tell
-    the environments apart. Instead we anchor on the runtime working directory:
-    ``run_shapes.py`` executes each notebook with cwd set to ``<repo>/notebooks``
-    (see tools/nb_compare), so walking up from cwd to the dir that contains
-    ``config/user_d.yml`` yields THIS environment's repo.
+    """Resolve the root of the *current* project.
 
     Resolution order:
       1. ``MSTR_REPO_ROOT`` environment variable, if set.
-      2. The nearest ancestor of the cwd that contains ``config/user_d.yml``.
-      3. Fall back to this file's install location (the package's own repo).
+      2. The nearest ancestor of the cwd that contains ``config/user_d.yml``
+         or ``config/user_d.example.yml`` (a project that has copied
+         mstr_robotics/utils/ in, whether or not setup has run yet).
+      3. The current working directory, if neither marker is found anywhere
+         above it.
+
+    Step 3 deliberately does NOT fall back to this file's install location
+    (e.g. site-packages) -- that would silently write config/output inside the
+    venv instead of the user's own project.
     """
     env = os.environ.get("MSTR_REPO_ROOT")
     if env:
         return Path(env).resolve()
     cwd = Path.cwd()
     for base in (cwd, *cwd.parents):
-        if (base / _MARKER).exists():
+        if any((base / marker).exists() for marker in _MARKERS):
             return base
-    return Path(__file__).resolve().parent.parent
+    return cwd
 
 
 REPO_ROOT = find_repo_root()

{mstr_robotics_magerdaniel-0.5.6 → mstr_robotics_magerdaniel-0.5.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "MSTR-Robotics-magerdaniel"
-version = "0.5.6"
+version = "0.5.8"
 description = "Automation toolkit for MicroStrategy / Strategy One: object read-out, migration, comparison, RAG and OSI export."
 readme = "README.md"
 requires-python = ">=3.12"