| Name | fabric-maverick JSON |
| Version |
0.1.0.post4
JSON |
| download |
| home_page | None |
| Summary | A Fabric Package for Semantic/Dataset validation |
| upload_time | 2025-06-24 16:29:58 |
| maintainer | None |
| docs_url | None |
| author | MAQ Software |
| requires_python | <3.12,>=3.10 |
| license | MIT License
Copyright (c) Microsoft Corporation.
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 |
| keywords |
fabric
microsoft fabric
sempy
semantic model
report
report compare
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Fabric Maverick
## Table of Contents
* [Overview](#overview)
* [Features](#features)
* [Installation](#installation)
* [Usage](#usage)
* [Comparing Reports](#comparing-reports)
* [Authentication](#authentication)
* [License](#license)
* [Contact](#contact)
## Overview
`fabric_maverick` is a Python package designed for **semantic level validation and comparison of Power BI reports across different workspaces**. It provides a robust framework to programmatically compare the metadata and structure of your Fabric Analytics Reports (formerly Power BI datasets/reports) to ensure consistency and identify discrepancies.
This package is particularly useful for:
* **CI/CD pipelines:** Automating report validation as part of your deployment process.
* **Regression testing:** Ensuring that changes to reports or underlying data models do not introduce unintended breaking changes.
* **Maintaining consistency:** Verifying that reports deployed to different environments (Dev, QA, Prod) are structurally identical or conform to expected variations.
## Features
* **Report Comparison:** Easily compare the structure (tables, columns, measures) of two Fabric Analytics Reports from different workspaces.
* **Flexible Input:** Supports comparing reports by providing individual report/workspace names or a consolidated dictionary structure.
* **Authentication Management:** Integrates with a flexible token provider for seamless authentication with Fabric/Power BI services.
* **Extensible:** Built with a modular design to allow for future expansion of comparison metrics and validation rules.
## Installation
`fabric_maverick` can be installed directly from PyPI using `pip`:
```bash
pip install fabric_maverick
```
## Usage
# Comparing Reports
The primary function for comparing reports is ReportCompare. It offers two ways to specify the reports:
```python
import knnpy
Compare = knnpy.ReportCompare(
OldReport="MySalesDashboard_V1",
OldReportWorkspace="Development",
NewReport="MySalesDashboard_V2",
NewReportWorkspace="Production",
Stream="SalesDashboard_Deployment",
ExplicitToken="YOUR_ACCESS_TOKEN_IF_NEEDED" # Optional
Threshold = "60", # Optional, defautls to 80
)
# Use the Compare object to run validations and view results
Compare.run_all_validations()
```
# Authentication
By default, fabric_maverick will use token from fabric enviornment. However, you can explicitly provide an authentication token using the ExplicitToken parameter in ReportCompare:
```python
import knnpy
# Obtain your Power BI/Fabric access token
my_token = "eyJ..." # Replace with your actual token
comparison_result = knnpy.ReportCompare(
# ... report details ...
Stream="MyStream",
ExplicitToken=my_token
)
```
Alternatively, you can initialize a token globally for the session using initializeToken:
```python
import knnpy
# Initialize token globally (this affects all subsequent calls without ExplicitToken)
knnpy.initializeToken("YOUR_GLOBAL_ACCESS_TOKEN")
# Now, ReportCompare calls can omit ExplicitToken
comparison_result = knnpy.ReportCompare(
OldReport="ReportA",
OldReportWorkspace="WS_A",
NewReport="ReportB",
NewReportWorkspace="WS_B",
Stream="AnotherStream"
)
```
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Contact
For questions or feedback, please reach out to the maintainers.
Raw data
{
"_id": null,
"home_page": null,
"name": "fabric-maverick",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.10",
"maintainer_email": "Nisarg Patel <nisargp@maqsoftware.com>, Kunal Sarda <kunals@maqsoftware.com>",
"keywords": "Fabric, Microsoft Fabric, Sempy, Semantic Model, Report, Report Compare",
"author": "MAQ Software",
"author_email": "Nisarg Patel <nisargp@maqsoftware.com>",
"download_url": "https://files.pythonhosted.org/packages/6b/ff/6a03ec9d2dbb8a934b058a1f2626ff9e4d9d1ac636570add7e1a9185045d/fabric_maverick-0.1.0.post4.tar.gz",
"platform": null,
"description": "# Fabric Maverick\r\n\r\n\r\n\r\n\r\n## Table of Contents\r\n\r\n* [Overview](#overview)\r\n* [Features](#features)\r\n* [Installation](#installation)\r\n* [Usage](#usage)\r\n * [Comparing Reports](#comparing-reports)\r\n * [Authentication](#authentication)\r\n* [License](#license)\r\n* [Contact](#contact)\r\n\r\n## Overview\r\n\r\n`fabric_maverick` is a Python package designed for **semantic level validation and comparison of Power BI reports across different workspaces**. It provides a robust framework to programmatically compare the metadata and structure of your Fabric Analytics Reports (formerly Power BI datasets/reports) to ensure consistency and identify discrepancies.\r\n\r\nThis package is particularly useful for:\r\n* **CI/CD pipelines:** Automating report validation as part of your deployment process.\r\n* **Regression testing:** Ensuring that changes to reports or underlying data models do not introduce unintended breaking changes.\r\n* **Maintaining consistency:** Verifying that reports deployed to different environments (Dev, QA, Prod) are structurally identical or conform to expected variations.\r\n\r\n## Features\r\n\r\n* **Report Comparison:** Easily compare the structure (tables, columns, measures) of two Fabric Analytics Reports from different workspaces.\r\n* **Flexible Input:** Supports comparing reports by providing individual report/workspace names or a consolidated dictionary structure.\r\n* **Authentication Management:** Integrates with a flexible token provider for seamless authentication with Fabric/Power BI services.\r\n* **Extensible:** Built with a modular design to allow for future expansion of comparison metrics and validation rules.\r\n\r\n## Installation\r\n\r\n`fabric_maverick` can be installed directly from PyPI using `pip`:\r\n```bash\r\npip install fabric_maverick\r\n```\r\n\r\n## Usage\r\n# Comparing Reports\r\nThe primary function for comparing reports is ReportCompare. It offers two ways to specify the reports:\r\n\r\n```python\r\nimport knnpy\r\n\r\nCompare = knnpy.ReportCompare(\r\n OldReport=\"MySalesDashboard_V1\",\r\n OldReportWorkspace=\"Development\",\r\n NewReport=\"MySalesDashboard_V2\",\r\n NewReportWorkspace=\"Production\",\r\n Stream=\"SalesDashboard_Deployment\",\r\n ExplicitToken=\"YOUR_ACCESS_TOKEN_IF_NEEDED\" # Optional\r\n Threshold = \"60\", # Optional, defautls to 80\r\n)\r\n\r\n# Use the Compare object to run validations and view results\r\nCompare.run_all_validations()\r\n```\r\n# Authentication\r\n\r\nBy default, fabric_maverick will use token from fabric enviornment. However, you can explicitly provide an authentication token using the ExplicitToken parameter in ReportCompare:\r\n\r\n```python\r\nimport knnpy\r\n\r\n# Obtain your Power BI/Fabric access token\r\nmy_token = \"eyJ...\" # Replace with your actual token\r\n\r\ncomparison_result = knnpy.ReportCompare(\r\n # ... report details ...\r\n Stream=\"MyStream\",\r\n ExplicitToken=my_token\r\n)\r\n```\r\nAlternatively, you can initialize a token globally for the session using initializeToken:\r\n\r\n```python\r\nimport knnpy\r\n\r\n# Initialize token globally (this affects all subsequent calls without ExplicitToken)\r\nknnpy.initializeToken(\"YOUR_GLOBAL_ACCESS_TOKEN\")\r\n\r\n# Now, ReportCompare calls can omit ExplicitToken\r\ncomparison_result = knnpy.ReportCompare(\r\n OldReport=\"ReportA\",\r\n OldReportWorkspace=\"WS_A\",\r\n NewReport=\"ReportB\",\r\n NewReportWorkspace=\"WS_B\",\r\n Stream=\"AnotherStream\"\r\n)\r\n```\r\n## License\r\nThis project is licensed under the MIT License - see the LICENSE file for details.\r\n\r\n## Contact\r\nFor questions or feedback, please reach out to the maintainers.\r\n",
"bugtrack_url": null,
"license": "MIT License\r\n \r\n Copyright (c) Microsoft Corporation.\r\n \r\n Permission is hereby granted, free of charge, to any person obtaining a copy\r\n of this software and associated documentation files (the \"Software\"), to deal\r\n in the Software without restriction, including without limitation the rights\r\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\n copies of the Software, and to permit persons to whom the Software is\r\n furnished to do so, subject to the following conditions:\r\n \r\n The above copyright notice and this permission notice shall be included in all\r\n copies or substantial portions of the Software.\r\n \r\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\n SOFTWARE",
"summary": "A Fabric Package for Semantic/Dataset validation",
"version": "0.1.0.post4",
"project_urls": null,
"split_keywords": [
"fabric",
" microsoft fabric",
" sempy",
" semantic model",
" report",
" report compare"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6bff6a03ec9d2dbb8a934b058a1f2626ff9e4d9d1ac636570add7e1a9185045d",
"md5": "735cfdab50f5892b1b6a2a998b1b3efa",
"sha256": "d69975d64e1961576ed0af95931d6841039e07d5a08c24803114933ba6cd2f34"
},
"downloads": -1,
"filename": "fabric_maverick-0.1.0.post4.tar.gz",
"has_sig": false,
"md5_digest": "735cfdab50f5892b1b6a2a998b1b3efa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.10",
"size": 14539,
"upload_time": "2025-06-24T16:29:58",
"upload_time_iso_8601": "2025-06-24T16:29:58.433755Z",
"url": "https://files.pythonhosted.org/packages/6b/ff/6a03ec9d2dbb8a934b058a1f2626ff9e4d9d1ac636570add7e1a9185045d/fabric_maverick-0.1.0.post4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-06-24 16:29:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fabric-maverick"
}
