codepbi 0.1.7__py3-none-any.whl

codepbi/writer.py

@@ -0,0 +1,238 @@
+from __future__ import annotations
+
+import json
+from pathlib import Path
+
+from .ids import guid
+from .model import Filter, Page, Report, Visual, field_ref
+
+PBIP_SCHEMA = "https://developer.microsoft.com/json-schemas/fabric/pbip/pbipProperties/1.0.0/schema.json"
+PLATFORM_SCHEMA = "https://developer.microsoft.com/json-schemas/fabric/gitIntegration/platformProperties/2.0.0/schema.json"
+PBIR_SCHEMA = "https://developer.microsoft.com/json-schemas/fabric/item/report/definitionProperties/2.0.0/schema.json"
+REPORT_SCHEMA = "https://developer.microsoft.com/json-schemas/fabric/item/report/definition/report/3.3.0/schema.json"
+VERSION_SCHEMA = "https://developer.microsoft.com/json-schemas/fabric/item/report/definition/versionMetadata/1.0.0/schema.json"
+PAGES_SCHEMA = "https://developer.microsoft.com/json-schemas/fabric/item/report/definition/pagesMetadata/1.1.0/schema.json"
+PAGE_SCHEMA = "https://developer.microsoft.com/json-schemas/fabric/item/report/definition/page/2.1.0/schema.json"
+VISUAL_SCHEMA = "https://developer.microsoft.com/json-schemas/fabric/item/report/definition/visualContainer/2.12.0/schema.json"
+
+
+def _write_json(path: Path, data: dict) -> None:
+    path.parent.mkdir(parents=True, exist_ok=True)
+    path.write_text(json.dumps(data, indent=2) + "\n", encoding="utf-8")
+
+
+def _projection(f) -> dict:
+    return {
+        "field": field_ref(f.entity, f.property, f.is_measure),
+        "queryRef": f.query_ref,
+        "nativeQueryRef": f.native_query_ref,
+    }
+
+
+def _filter_json(filt: Filter) -> dict:
+    base = {
+        "name": filt.name,
+        "field": field_ref(filt.entity, filt.property),
+        "type": filt.kind,
+    }
+    if filt.kind == "Advanced" and filt.value is not None:
+        base["filter"] = {
+            "Version": 2,
+            "From": [{"Name": "c", "Entity": filt.entity, "Type": 0}],
+            "Where": [
+                {
+                    "Condition": {
+                        "Comparison": {
+                            "ComparisonKind": 0,
+                            "Left": {
+                                "Column": {
+                                    "Expression": {"SourceRef": {"Source": "c"}},
+                                    "Property": filt.property,
+                                }
+                            },
+                            "Right": {"Literal": {"Value": f"'{filt.value}'"}},
+                        }
+                    }
+                }
+            ],
+        }
+        base["howCreated"] = "User"
+    return base
+
+
+def _visual_json(visual: Visual) -> dict:
+    pos = visual.position
+    data = {
+        "$schema": VISUAL_SCHEMA,
+        "name": visual.name,
+        "position": {
+            "x": pos.x,
+            "y": pos.y,
+            "z": pos.z,
+            "height": pos.height,
+            "width": pos.width,
+            "tabOrder": pos.tab_order,
+        },
+    }
+    if visual.visual_group is not None:
+        group_body = dict(visual.visual_group)
+        if visual.objects:
+            group_body["objects"] = visual.objects
+        data["visualGroup"] = group_body
+    else:
+        visual_body = {
+            "visualType": visual.visual_type,
+            "drillFilterOtherVisuals": visual.drill_filter_other_visuals,
+        }
+        if visual.roles:
+            # Static visuals (textbox, image) have no query roles at all -- confirmed from
+            # real Desktop-saved examples, not just an empty queryState.
+            query_state = {
+                role: {"projections": [_projection(f) for f in fields]}
+                for role, fields in visual.roles.items()
+            }
+            visual_body["query"] = {"queryState": query_state}
+        if visual.objects:
+            visual_body["objects"] = visual.objects
+        if visual.visual_container_objects:
+            visual_body["visualContainerObjects"] = visual.visual_container_objects
+        data["visual"] = visual_body
+    if visual.parent_group_name:
+        data["parentGroupName"] = visual.parent_group_name
+    if visual.filters:
+        data["filterConfig"] = {"filters": [_filter_json(f) for f in visual.filters]}
+    return data
+
+
+def _page_json(page: Page) -> dict:
+    data = {
+        "$schema": PAGE_SCHEMA,
+        "name": page.name,
+        "displayName": page.display_name,
+        "displayOption": page.display_option,
+        "height": page.height,
+        "width": page.width,
+    }
+    if page.page_type:
+        data["type"] = page.page_type
+    if page.page_binding:
+        data["pageBinding"] = page.page_binding
+    if page.visual_interactions:
+        data["visualInteractions"] = page.visual_interactions
+    if page.objects:
+        data["objects"] = page.objects
+    if page.filters:
+        data["filterConfig"] = {"filters": [_filter_json(f) for f in page.filters]}
+    return data
+
+
+def _report_json(report: Report) -> dict:
+    theme_collection = {}
+    # Theme + images share ONE "RegisteredResources" package -- confirmed from a real
+    # Desktop-saved report with both a custom theme and a logo image.
+    registered_items = []
+    if report.theme:
+        theme_name = report.theme["name"]
+        theme_collection["customTheme"] = {
+            "name": theme_name,
+            "reportVersionAtImport": {"visual": "1.0.0", "page": "1.0.0", "report": "1.0.0"},
+            "type": "RegisteredResources",
+        }
+        # path is just the bare theme name -- no folder prefix, no extension. Confirmed:
+        # Desktop normalized our original "RegisteredResources/<name>.json" guess down to this.
+        registered_items.append({"name": theme_name, "path": theme_name, "type": "CustomTheme"})
+    for resource_name, _local_path in report.images:
+        registered_items.append({"name": resource_name, "path": resource_name, "type": "Image"})
+    resource_packages = (
+        [{"name": "RegisteredResources", "type": "RegisteredResources", "items": registered_items}]
+        if registered_items else []
+    )
+    data = {
+        "$schema": REPORT_SCHEMA,
+        # Required by the schema -- an empty object is valid (baseTheme/customTheme
+        # are both optional sub-fields), and Desktop applies its own default theme.
+        "themeCollection": theme_collection,
+        "settings": {
+            "useStylableVisualContainerHeader": True,
+            "exportDataMode": "AllowSummarized",
+            "defaultDrillFilterOtherVisuals": True,
+            "allowChangeFilterTypes": True,
+            "useEnhancedTooltips": True,
+            "useDefaultAggregateDisplayName": True,
+        },
+    }
+    if resource_packages:
+        data["resourcePackages"] = resource_packages
+    if report.filters:
+        data["filterConfig"] = {"filters": [_filter_json(f) for f in report.filters]}
+    return data
+
+
+def write_report(report: Report, parent_dir: str) -> str:
+    """Write a full .pbip + .Report folder tree. Does not create the semantic model --
+    `report.semantic_model_path` must point at one that already exists (relative to the .Report folder)."""
+    parent = Path(parent_dir)
+    report_dir = parent / f"{report.name}.Report"
+
+    _write_json(
+        parent / f"{report.name}.pbip",
+        {
+            "$schema": PBIP_SCHEMA,
+            "version": "1.0",
+            "artifacts": [{"report": {"path": f"{report.name}.Report"}}],
+            "settings": {"enableAutoRecovery": True},
+        },
+    )
+
+    _write_json(
+        report_dir / ".platform",
+        {
+            "$schema": PLATFORM_SCHEMA,
+            "metadata": {"type": "Report", "displayName": report.name},
+            "config": {"version": "2.0", "logicalId": guid()},
+        },
+    )
+
+    _write_json(
+        report_dir / "definition.pbir",
+        {
+            "$schema": PBIR_SCHEMA,
+            "version": "4.0",
+            "datasetReference": {"byPath": {"path": report.semantic_model_path}},
+        },
+    )
+
+    _write_json(report_dir / "definition" / "report.json", _report_json(report))
+
+    if report.theme:
+        _write_json(
+            report_dir / "StaticResources" / "RegisteredResources" / f"{report.theme['name']}.json",
+            report.theme,
+        )
+
+    for resource_name, local_path in report.images:
+        dest = report_dir / "StaticResources" / "RegisteredResources" / resource_name
+        dest.parent.mkdir(parents=True, exist_ok=True)
+        dest.write_bytes(Path(local_path).read_bytes())
+
+    _write_json(
+        report_dir / "definition" / "version.json",
+        {"$schema": VERSION_SCHEMA, "version": "2.0.0"},
+    )
+
+    _write_json(
+        report_dir / "definition" / "pages" / "pages.json",
+        {
+            "$schema": PAGES_SCHEMA,
+            "pageOrder": [p.name for p in report.pages],
+            "activePageName": report.active_page_name,
+        },
+    )
+
+    for page in report.pages:
+        page_dir = report_dir / "definition" / "pages" / page.name
+        _write_json(page_dir / "page.json", _page_json(page))
+        for visual in page.visuals:
+            _write_json(page_dir / "visuals" / visual.name / "visual.json", _visual_json(visual))
+
+    return str(report_dir)

codepbi-0.1.7.dist-info/METADATA

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: codepbi
+Version: 0.1.7
+Summary: Code-first Power BI — define pages/visuals in Python and emit a working PBIP/PBIR report; sync a TMDL semantic model from a dbt project.
+Author: Ryan Thomas
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/ryantthomas/codepbi
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: semantic
+Requires-Dist: pyyaml; extra == "semantic"
+Requires-Dist: sqlglot; extra == "semantic"
+Requires-Dist: pythonnet; extra == "semantic"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# codepbi
+
+Code-first Power BI. Define pages and visuals in Python, get a working PBIP/PBIR
+report that opens and edits normally in Power BI Desktop.
+
+```python
+from codepbi import Field, Filter, Position, Report
+
+report = Report(name="Sales Overview", semantic_model_path="../Sales.SemanticModel")
+page = report.add_page("Overview")
+page.add_slicer(Field("Orders", "Region"), Position(x=0, y=0, width=200, height=400))
+page.add_table(
+    fields=[Field("Orders", "Region"), Field("Orders", "Order Amount")],
+    position=Position(x=220, y=0, width=800, height=400),
+    filters=[Filter.equals("Orders", "Status", "Active")],
+)
+report.save("output_dir")
+```
+
+## `codepbi.semantic`
+
+A separate module for the other half of the workflow: syncing a Power BI TMDL
+semantic model *from* a dbt project, via the Tabular Object Model (TOM). Treats
+dbt's schema YAML as the source of truth for columns, and a dbt-semantic-layer-
+style `semantic_models/*.yml` (entities + measures) as the source of truth for
+joins and DAX measures.
+
+```python
+from codepbi.semantic import TmdlProjectConfig, sync_descriptions, sync_measures, sync_relationships
+
+config = TmdlProjectConfig(
+    dbt_project_dir="path/to/dbt_project",
+    semantic_model_definition_dir="path/to/Model.SemanticModel/definition",
+    tom_lib_dir="path/to/analysis-services-dlls",
+)
+
+sync_measures.sync(config)
+sync_descriptions.sync(config)   # also validates the resulting model
+sync_relationships.sync(config)
+```
+
+Requires the `semantic` extra (`pip install codepbi[semantic]`) plus the
+`Microsoft.AnalysisServices.NetCore.retail.amd64` NuGet package's DLLs, obtained
+separately and pointed at via `tom_lib_dir` (not redistributed here).
+
+## Install
+
+```bash
+pip install -e .           # report/visual builder only
+pip install -e ".[semantic]"  # + the dbt-to-TMDL sync module
+```
+
+## License
+
+MIT

codepbi-0.1.7.dist-info/RECORD

@@ -0,0 +1,20 @@
+codepbi/__init__.py,sha256=sAC2xsHqqSST-_arq8GEFeDZ9nDPX67vw_gERVOgTYM,334
+codepbi/ids.py,sha256=5i4ALYWLZYp9bj5u__BpzFD3k3Jwcr0enDFMvQ9IP0Y,272
+codepbi/model.py,sha256=Hk_omy24KrCUwOWgQUT14S9uPuFEf9GKn9CfmUAr5vI,16933
+codepbi/writer.py,sha256=YnSRyV7W_Adx9NvE6S_XW1U0wLwBjWD9cTc73-SupfI,9064
+codepbi/semantic/__init__.py,sha256=3MiYIdZCd6fXcxyWoWLodmuIDy9KkenDcalnP5hc-F0,1408
+codepbi/semantic/check_drift.py,sha256=TMSYRYiXpeXJq5gLaV4HshKDaqmnQ6KN8ZteSmZlB8k,1691
+codepbi/semantic/check_schema_vs_sql.py,sha256=CvV84Qg-t6aQqIg3QOu630Jzx_rpQSSbaqkXD6HVxPc,2623
+codepbi/semantic/config.py,sha256=GxChvIe3OwThfMPmwHjHS2d1MEBWf4MON5fFEDVq5gY,3291
+codepbi/semantic/dbt_sql.py,sha256=mRh2BGhf25dGSUwWSAwjm5VDUDcdMRBsBnLZL_1Xk0A,2850
+codepbi/semantic/schema_loader.py,sha256=h4WFjrvjU7ZfTzCuDK5NE9roxEAvQQYusRYMeU4jUV0,6012
+codepbi/semantic/sync_descriptions.py,sha256=t_te5YrBVqq8opNQIgrbDcjZnlJf1VlHf6OZ-xPrkSA,6084
+codepbi/semantic/sync_measures.py,sha256=J78B2yP3idc6_3YKyP1yIM-yUl_ClT1Bxw33ryIhMM8,5020
+codepbi/semantic/sync_relationships.py,sha256=TnHg6b3MXBwWhh0Btht8KJs6AocUwVd_6HaFbj0ieds,9920
+codepbi/semantic/tom_utils.py,sha256=Q9YjhNaHel33e007SQFLZltUmgab5_FYvvn8PY3FIz4,3812
+codepbi/semantic/validate_tmdl.py,sha256=85oDtZ97_B-rfH0uAFu9sGG7HwkzncOMmbCziejcVeU,9893
+codepbi-0.1.7.dist-info/licenses/LICENSE,sha256=7GtHbapYMAtkjp_8KUJr9WO_7QvuML78C0u1ECJ0rOk,1068
+codepbi-0.1.7.dist-info/METADATA,sha256=byIZ9VXe0DZCmCepydhdEviW3vgN2u3-pF8xPri4MbY,2557
+codepbi-0.1.7.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+codepbi-0.1.7.dist-info/top_level.txt,sha256=SYYZLt2dpUrDnveNvzA3ukuPDEanEX0ReeLYexlZOlo,8
+codepbi-0.1.7.dist-info/RECORD,,

codepbi-0.1.7.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

codepbi-0.1.7.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryan Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

codepbi-0.1.7.dist-info/top_level.txt

@@ -0,0 +1 @@
+codepbi