MSTR-Robotics-magerdaniel 0.5.5__tar.gz → 0.5.7__tar.gz

{mstr_robotics_magerdaniel-0.5.5 → mstr_robotics_magerdaniel-0.5.7}/MSTR_Robotics_magerdaniel.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MSTR-Robotics-magerdaniel
-Version: 0.5.5
+Version: 0.5.7
 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
@@ -43,7 +43,7 @@ A Python toolkit for MicroStrategy automation, object comparison, and Redis-base
 ## Project Structure
 
 - `mstr_robotics/` - Main package with core functionality
-- `mstr_robotics/notebooks/` - Jupyter notebooks for analysis and exploration
+- `notebooks/` - Jupyter notebooks for analysis and exploration
 - `Dansfiles/` - Migration and automation scripts
 - `config/` - Configuration files (YAML, JSON)
 - `export/` - Export utilities and logs
@@ -58,7 +58,7 @@ A Python toolkit for MicroStrategy automation, object comparison, and Redis-base
 
 ## Usage
 
-The Jupyter notebooks in `mstr_robotics/notebooks/` are the primary entry points (object
+The Jupyter notebooks in `notebooks/` are the primary entry points (object
 export, schema monitoring, migration, REGAM regression testing).
 
 ## Development

{mstr_robotics_magerdaniel-0.5.5 → mstr_robotics_magerdaniel-0.5.7}/MSTR_Robotics_magerdaniel.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ config/dans_migrations.example.yml
 config/jupyter_objects_d.example.yml
 config/mstr_redis_y.example.yml
 config/user_d.example.yml
+docs/SETUP.md
 mstr_robotics/__init__.py
 mstr_robotics/_connectors.py
 mstr_robotics/_export.py
@@ -41,13 +42,13 @@ mstr_robotics/mcp_servers/_osi_specific_analysis.py
 mstr_robotics/mcp_servers/_run_mstr_report_wizzard.py
 mstr_robotics/mcp_servers/_server_config.py
 mstr_robotics/mcp_servers/mstr_osi_mcp.py
-mstr_robotics/notebooks/00_setup.ipynb
-mstr_robotics/notebooks/jup_REGAM.ipynb
-mstr_robotics/notebooks/jup_chat_answer_prompt_page.ipynb
-mstr_robotics/notebooks/jup_load_rag_cubes.ipynb
-mstr_robotics/notebooks/jup_migrate.ipynb
-mstr_robotics/notebooks/jup_mstr_admin.ipynb
-mstr_robotics/notebooks/jup_prj_obj_exporter.ipynb
-mstr_robotics/notebooks/jup_schema_monitor.ipynb
 mstr_robotics/osi_exporter/__init__.py
-mstr_robotics/osi_exporter/export_dashboard.py
+mstr_robotics/osi_exporter/export_dashboard.py
+notebooks/00_setup.ipynb
+notebooks/jup_REGAM.ipynb
+notebooks/jup_chat_answer_prompt_page.ipynb
+notebooks/jup_load_rag_cubes.ipynb
+notebooks/jup_migrate.ipynb
+notebooks/jup_mstr_admin.ipynb
+notebooks/jup_prj_obj_exporter.ipynb
+notebooks/jup_schema_monitor.ipynb

mstr_robotics_magerdaniel-0.5.7/MSTR_Robotics_magerdaniel.egg-info/top_level.txt

@@ -0,0 +1 @@
+mstr_robotics

{mstr_robotics_magerdaniel-0.5.5 → mstr_robotics_magerdaniel-0.5.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MSTR-Robotics-magerdaniel
-Version: 0.5.5
+Version: 0.5.7
 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
@@ -43,7 +43,7 @@ A Python toolkit for MicroStrategy automation, object comparison, and Redis-base
 ## Project Structure
 
 - `mstr_robotics/` - Main package with core functionality
-- `mstr_robotics/notebooks/` - Jupyter notebooks for analysis and exploration
+- `notebooks/` - Jupyter notebooks for analysis and exploration
 - `Dansfiles/` - Migration and automation scripts
 - `config/` - Configuration files (YAML, JSON)
 - `export/` - Export utilities and logs
@@ -58,7 +58,7 @@ A Python toolkit for MicroStrategy automation, object comparison, and Redis-base
 
 ## Usage
 
-The Jupyter notebooks in `mstr_robotics/notebooks/` are the primary entry points (object
+The Jupyter notebooks in `notebooks/` are the primary entry points (object
 export, schema monitoring, migration, REGAM regression testing).
 
 ## Development

{mstr_robotics_magerdaniel-0.5.5 → mstr_robotics_magerdaniel-0.5.7}/README.md

@@ -11,7 +11,7 @@ A Python toolkit for MicroStrategy automation, object comparison, and Redis-base
 ## Project Structure
 
 - `mstr_robotics/` - Main package with core functionality
-- `mstr_robotics/notebooks/` - Jupyter notebooks for analysis and exploration
+- `notebooks/` - Jupyter notebooks for analysis and exploration
 - `Dansfiles/` - Migration and automation scripts
 - `config/` - Configuration files (YAML, JSON)
 - `export/` - Export utilities and logs
@@ -26,7 +26,7 @@ A Python toolkit for MicroStrategy automation, object comparison, and Redis-base
 
 ## Usage
 
-The Jupyter notebooks in `mstr_robotics/notebooks/` are the primary entry points (object
+The Jupyter notebooks in `notebooks/` are the primary entry points (object
 export, schema monitoring, migration, REGAM regression testing).
 
 ## Development

mstr_robotics_magerdaniel-0.5.7/docs/SETUP.md

@@ -0,0 +1,121 @@
+# Setup
+
+Three stages, in order. Stage 2 is one notebook; stage 3 is automatic.
+
+1. [Install the Python package](#1-install-the-python-package)
+2. [Deploy the Object Manager packages](#2-deploy-the-object-manager-packages)
+3. [Run the setup notebook](#3-run-the-setup-notebook)
+
+---
+
+## 1. Install the Python package
+
+Requires **Python 3.12+** and network access to a MicroStrategy Library REST endpoint.
+
+```bash
+git clone https://github.com/magerdaniel/MSTR_Robotics.git
+cd MSTR_Robotics
+python -m venv .venv
+.venv\Scripts\Activate.ps1        # Windows;  source .venv/bin/activate on Unix
+pip install -e .
+```
+
+The base install is deliberately small — connection, object read-out, comparison and
+migration. Add only what you need:
+
+| Command | Adds |
+|---|---|
+| `pip install -e ".[rag]"` | OpenAI / Perplexity — the chat and RAG notebooks |
+| `pip install -e ".[redis]"` | Redis-backed metadata analysis |
+| `pip install -e ".[azure]"` | Azure Blob staging for migration packages |
+| `pip install -e ".[servers]"` | the MCP servers |
+| `pip install -e ".[all]"` | everything above |
+| `pip install -e ".[dev]"` | ruff, vulture, jupyter |
+
+---
+
+## 2. Deploy the Object Manager packages
+
+The notebooks and the libraries read from cubes, reports and dossiers that must exist in **your**
+MicroStrategy environment. Further they write into cubes. To simplify your start, everything is pre-configured for MSTR - Tutorial. You'll find the relevant mmp files for Tutorial and Platform Analytics in the file mstr_robotics_demo.zip under
+[`Object_Manager_Packages/`](../Object_Manager_Packages/).
+
+### Prerequisites
+
+- Access to MSTR Tutorial and Platform Analytics over Workstation and Library as developer
+- Python environment with the posibility to pip install
+- A POC or development environment is recomended
+
+### Packages
+
+| Package | Provides |
+|---|---|
+| `mstr_robotics_tutorial.mmp` | contains the folder structure, the MTDI-cubes and MSTR application objects.  — **deploy this first** |
+| `PA_mstr_robotics.mmp` | is only needed for REGAM regession testing. Using this report, we can fetch user job for re-play out of PA |
+
+
+### If a package fails to import
+
+Send me a mail to daniel@magdata.de.
+
+---
+
+## 3. Run the setup notebook
+
+```bash
+jupyter lab notebooks/00_setup.ipynb
+```
+
+Run it top to bottom. It creates the output folders, copies the config templates,
+validates what you filled in, verifies the connection, and then **resolves the object
+GUIDs automatically**.
+
+### If you want to use your 
+
+If you want or need to modify the cubes, reports or objects, you can use this feature to check if they all fit. 
+This saves a lot of time and nervs. `config/jupyter_objects_d.example.yml` are meaningless if the do not exist. Their *names* are fixed
+by the packages, so the notebook searches your project by name and writes the correct
+GUIDs into `config/jupyter_objects_d.yml` for you.
+
+If a name is reported as **not found**, the package providing it has not been deployed.
+If a name is **ambiguous**, your project has duplicates — set that ID by hand.
+
+### Configuration reference
+
+Every live config is gitignored; each ships an `.example` twin that
+`00_setup.ipynb` copies for you.
+
+| File | Needed for |
+|---|---|
+| `config/user_d.yml` | everything — connection and project GUIDs |
+| `config/jupyter_objects_d.yml` | the notebooks; filled in automatically in step 5 |
+| `config/API_KEY.env` | RAG notebooks and the MCP servers |
+| `config/mstr_redis_y.yml` | Redis-backed metadata analysis |
+| `config/dans_migrations.yml` | Azure-staged migrations |
+
+`config/user_d.yml` doubles as the marker file `mstr_robotics._paths` uses to locate the
+repo root, so it must exist even if you override paths via environment variables.
+
+### Where files are written
+
+| Variable | Default | Holds |
+|---|---|---|
+| `MSTR_REPO_ROOT` | auto-detected from `config/user_d.yml` | repo root |
+| `MSTR_OSI_DIR` | `<repo>/data/osi` | generated OSI YAML |
+| `MSTR_OUTPUT_DIR` | `<repo>/output` | exports, logs, MCP data |
+
+---
+
+## Troubleshooting
+
+**`Cannot save file into a non-existent directory`** — the output folders were never
+created. Run step 1 of `00_setup.ipynb`, or `python -c "from mstr_robotics import setup; print(setup.ensure_dirs())"`.
+
+**`MicroStrategy configuration not found`** — `config/user_d.yml` is missing. Run step 2
+of the setup notebook.
+
+**`no object named '...'`** during GUID discovery — the Object Manager package providing
+that object has not been deployed to the project you connected to.
+
+**Config still points at the reference environment** — you copied the template but did
+not edit it. `setup.check_configs()` reports this explicitly.

{mstr_robotics_magerdaniel-0.5.5 → mstr_robotics_magerdaniel-0.5.7}/mstr_robotics/__init__.py

@@ -1,7 +1,7 @@
 """mstr_robotics — automation toolkit for MicroStrategy / Strategy One.
 
 Object read-out, migration packaging, environment comparison, RAG helpers
-and OSI dashboard export, driven by the Jupyter notebooks in ``mstr_robotics/notebooks/``.
+and OSI dashboard export, driven by the Jupyter notebooks in ``notebooks/``.
 """
 
-__version__ = "0.5.5"
+__version__ = "0.5.7"

{mstr_robotics_magerdaniel-0.5.5 → mstr_robotics_magerdaniel-0.5.7}/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,25 +27,24 @@ from __future__ import annotations
 import os
 from pathlib import Path
 
-# Marker that identifies a repo root (every environment has its own copy).
+# Marker that identifies a project root (every environment has its own copy).
 _MARKER = Path("config") / "user_d.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>/mstr_robotics/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``
+         (a project that has already run setup at least once).
+      3. The current working directory, on the assumption this is a fresh
+         project where the user just copied ``mstr_robotics/utils/`` in and is
+         about to run setup for the first time.
+
+    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:
@@ -47,7 +53,7 @@ def find_repo_root() -> Path:
     for base in (cwd, *cwd.parents):
         if (base / _MARKER).exists():
             return base
-    return Path(__file__).resolve().parent.parent
+    return cwd
 
 
 REPO_ROOT = find_repo_root()

{mstr_robotics_magerdaniel-0.5.5 → mstr_robotics_magerdaniel-0.5.7}/mstr_robotics/mcp_servers/_run_mstr_report_wizzard.py

@@ -5,7 +5,7 @@ keyword-extraction → Perplexity RAG → prompt-answering → report-execution
 pipeline and returns the result as CSV plus a browser link.
 
 Importing this module loads the four RAG cubes into DataFrames (same loading
-logic as mstr_robotics/notebooks/jup_chat_answer_prompt_page.ipynb) and builds the
+logic as notebooks/jup_chat_answer_prompt_page.ipynb) and builds the
 flash-text keyword index — i.e. it happens once when the MCP server process
 starts. Every query_bi_report call afterwards is served from the in-memory
 copies and reuses the shared session-managed connection (_server_config).

{mstr_robotics_magerdaniel-0.5.5 → mstr_robotics_magerdaniel-0.5.7}/mstr_robotics/mcp_servers/_server_config.py

@@ -33,7 +33,7 @@ try:
 except FileNotFoundError as exc:
     raise RuntimeError(
         f"MicroStrategy configuration not found at {USER_CONFIG}.\n"
-        "Run the setup notebook (mstr_robotics/notebooks/00_setup.ipynb), or copy the template by hand:\n"
+        "Run the setup notebook (notebooks/00_setup.ipynb), or copy the template by hand:\n"
         f"    cp {USER_CONFIG.parent / 'user_d.example.yml'} {USER_CONFIG}\n"
         "then fill in base_url, username, password and project_id."
     ) from exc

{mstr_robotics_magerdaniel-0.5.5 → mstr_robotics_magerdaniel-0.5.7}/mstr_robotics/setup.py

@@ -1,4 +1,4 @@
-"""First-time setup helpers, driven by ``mstr_robotics/notebooks/00_setup.ipynb``.
+"""First-time setup helpers, driven by ``notebooks/00_setup.ipynb``.
 
 Each function performs one setup step and returns a :class:`StepResult` instead
 of raising, so the setup notebook can show every problem at once rather than
@@ -43,7 +43,7 @@ from mstr_robotics._paths import (
 _PLACEHOLDER_MARKERS = ("_guid", "your", "you account", "changeme", "placeholder")
 
 # Directories the package writes into. Nothing else creates these, and pandas
-# `to_csv` / `open(..., "w")` do not create parents -- see mstr_robotics/notebooks/00_setup.ipynb.
+# `to_csv` / `open(..., "w")` do not create parents -- see notebooks/00_setup.ipynb.
 _WRITABLE_DIRS = (OSI_DIR, OSI_DASHBOARD_CONTEXT, OUTPUT_DIR, MCP_DATA)
 
 # Configs every user must customise. The rest are feature-specific and may

{mstr_robotics_magerdaniel-0.5.5 → mstr_robotics_magerdaniel-0.5.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "MSTR-Robotics-magerdaniel"
-version = "0.5.5"
+version = "0.5.7"
 description = "Automation toolkit for MicroStrategy / Strategy One: object read-out, migration, comparison, RAG and OSI export."
 readme = "README.md"
 requires-python = ">=3.12"
@@ -52,14 +52,32 @@ dev = [
     "jupyter",
 ]
 
-[tool.setuptools.packages.find]
-include = ["mstr_robotics*", "config", "OSI_Produktion"]
-namespaces = true
+[tool.setuptools]
+packages = [
+    "mstr_robotics",
+    "mstr_robotics.mcp_servers",
+    "mstr_robotics.osi_exporter",
+    "mstr_robotics.utils.notebooks",
+    "mstr_robotics.utils.config",
+    "mstr_robotics.utils.docs",
+    "mstr_robotics.utils.OSI_Produktion",
+]
+
+# Repo layout keeps notebooks/, config/, docs/, OSI_Produktion/ at project level;
+# these map them into mstr_robotics/utils/ only inside the built package, so
+# `pip install`ers get a self-contained, copy-pasteable bundle of reference
+# material alongside the code.
+[tool.setuptools.package-dir]
+"mstr_robotics.utils.notebooks" = "notebooks"
+"mstr_robotics.utils.config" = "config"
+"mstr_robotics.utils.docs" = "docs"
+"mstr_robotics.utils.OSI_Produktion" = "OSI_Produktion"
 
 [tool.setuptools.package-data]
-config = ["*.example.*"]
-OSI_Produktion = ["*.yml"]
-mstr_robotics = ["notebooks/*.ipynb"]
+"mstr_robotics.utils.notebooks" = ["*.ipynb"]
+"mstr_robotics.utils.config" = ["*.example.*"]
+"mstr_robotics.utils.docs" = ["*.md"]
+"mstr_robotics.utils.OSI_Produktion" = ["*.yml"]
 
 [tool.ruff]
 line-length = 120

mstr_robotics_magerdaniel-0.5.5/MSTR_Robotics_magerdaniel.egg-info/top_level.txt

@@ -1,3 +0,0 @@
-OSI_Produktion
-config
-mstr_robotics