semantic-link-labs 0.8.11__tar.gz → 0.9.0__tar.gz

{semantic_link_labs-0.8.11 → semantic_link_labs-0.9.0}/.github/workflows/build.yaml

@@ -16,6 +16,12 @@ jobs:
         with:
           python-version: "3.10"
 
+      - name: Setup dotnet
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: | 
+            8.0.x
+
       - name: Get Date
         id: get-date
         run: echo "today=$(/bin/date -u '+%Y%m%d')" >> $GITHUB_OUTPUT

{semantic_link_labs-0.8.11 → semantic_link_labs-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: semantic-link-labs
-Version: 0.8.11
+Version: 0.9.0
 Summary: Semantic Link Labs for Microsoft Fabric
 Author: Microsoft Corporation
 License: MIT License
@@ -15,11 +15,10 @@ Classifier: Framework :: Jupyter
 Requires-Python: <3.12,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: semantic-link-sempy>=0.8.3
+Requires-Dist: semantic-link-sempy>=0.8.5
 Requires-Dist: anytree
 Requires-Dist: powerbiclient
 Requires-Dist: polib
-Requires-Dist: azure.mgmt.resource
 Requires-Dist: jsonpath_ng
 Provides-Extra: test
 Requires-Dist: pytest>=8.2.1; extra == "test"
@@ -27,7 +26,7 @@ Requires-Dist: pytest>=8.2.1; extra == "test"
 # Semantic Link Labs
 
 [![PyPI version](https://badge.fury.io/py/semantic-link-labs.svg)](https://badge.fury.io/py/semantic-link-labs)
-[![Read The Docs](https://readthedocs.org/projects/semantic-link-labs/badge/?version=0.8.11&style=flat)](https://readthedocs.org/projects/semantic-link-labs/)
+[![Read The Docs](https://readthedocs.org/projects/semantic-link-labs/badge/?version=0.9.0&style=flat)](https://readthedocs.org/projects/semantic-link-labs/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Downloads](https://static.pepy.tech/badge/semantic-link-labs)](https://pepy.tech/project/semantic-link-labs)
 
@@ -142,6 +141,7 @@ An even better way to ensure the semantic-link-labs library is available in your
 2. Select your newly created environment within the 'Environment' drop down in the navigation bar at the top of the notebook
 
 ## Version History
+* [0.9.0](https://github.com/microsoft/semantic-link-labs/releases/tag/0.9.0) (January 22, 2024)
 * [0.8.11](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.11) (December 19, 2024)
 * [0.8.10](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.10) (December 16, 2024)
 * [0.8.9](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.9) (December 4, 2024)

{semantic_link_labs-0.8.11 → semantic_link_labs-0.9.0}/README.md

@@ -1,7 +1,7 @@
 # Semantic Link Labs
 
 [![PyPI version](https://badge.fury.io/py/semantic-link-labs.svg)](https://badge.fury.io/py/semantic-link-labs)
-[![Read The Docs](https://readthedocs.org/projects/semantic-link-labs/badge/?version=0.8.11&style=flat)](https://readthedocs.org/projects/semantic-link-labs/)
+[![Read The Docs](https://readthedocs.org/projects/semantic-link-labs/badge/?version=0.9.0&style=flat)](https://readthedocs.org/projects/semantic-link-labs/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Downloads](https://static.pepy.tech/badge/semantic-link-labs)](https://pepy.tech/project/semantic-link-labs)
 
@@ -116,6 +116,7 @@ An even better way to ensure the semantic-link-labs library is available in your
 2. Select your newly created environment within the 'Environment' drop down in the navigation bar at the top of the notebook
 
 ## Version History
+* [0.9.0](https://github.com/microsoft/semantic-link-labs/releases/tag/0.9.0) (January 22, 2024)
 * [0.8.11](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.11) (December 19, 2024)
 * [0.8.10](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.10) (December 16, 2024)
 * [0.8.9](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.9) (December 4, 2024)

{semantic_link_labs-0.8.11 → semantic_link_labs-0.9.0}/docs/requirements.txt

@@ -11,5 +11,4 @@ anytree
 IPython
 polib
 powerbiclient
-azure.mgmt.resource
 jsonpath_ng

{semantic_link_labs-0.8.11 → semantic_link_labs-0.9.0}/docs/source/conf.py

@@ -13,7 +13,7 @@ sys.path.insert(0, os.path.abspath('../../src/'))
 project = 'semantic-link-labs'
 copyright = '2024, Microsoft and community'
 author = 'Microsoft and community'
-release = '0.8.11'
+release = '0.9.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{semantic_link_labs-0.8.11 → semantic_link_labs-0.9.0}/environment.yml

@@ -6,7 +6,7 @@ dependencies:
 - pytest-cov
 - pytest-mock
 - pip:
-  - semantic-link-sempy>=0.8.3
+  - semantic-link-sempy>=0.8.5
   - azure-identity==1.7.1
   - azure-storage-blob>=12.9.0
   - pandas-stubs

semantic_link_labs-0.9.0/notebooks/Capacity Migration.ipynb

@@ -0,0 +1,340 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "5c27dfd1-4fe0-4a97-92e6-ddf78889aa93",
+   "metadata": {
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "source": [
+    "### Install the latest .whl package\n",
+    "\n",
+    "Check [here](https://pypi.org/project/semantic-link-labs/) to see the latest version."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d5cae9db-cef9-48a8-a351-9c5fcc99645c",
+   "metadata": {
+    "jupyter": {
+     "outputs_hidden": true,
+     "source_hidden": false
+    },
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "outputs": [],
+   "source": [
+    "%pip install semantic-link-labs"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "2856d26d",
+   "metadata": {},
+   "source": [
+    "### Requirements\n",
+    "* Must have an Azure Subscription\n",
+    "* Must [register an App](https://ms.portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade)\n",
+    "    * Permissions: Will need the Contributor role at the scope where the resources will be created, which is often the subscription level\n",
+    "* Azure Key Vault\n",
+    "    * [Set up](https://learn.microsoft.com/azure/key-vault/secrets/quick-create-portal) within the Azure Subscription\n",
+    "    * Save secrets for the Tenant ID, Client ID (Application ID), Client Secret\n",
+    "    * Permissions: Ensure the user who will be executing the notebooks has “Key Vault Secrets User”\n",
+    "* Fabric Permissions\n",
+    "    * User should be a tenant admin. This ensures they have the necessary authority to execute and manage the notebooks without encountering permission issues.\n",
+    "\n",
+    "### Result\n",
+    "* F skus are created for each (specified) capacity\n",
+    "    * Within the same region as the P SKU\n",
+    "    * Equivalent SKU size as the P SKU\n",
+    "    * Same admins as listed on the P SKU\n",
+    "    * All workspaces are migrated to the corresponding new capacity\n",
+    "* The names of the newly created F SKU capacities will be an alphanumeric lowercase version of the P SKU capacity name, suffixed with 'fsku'. As an example: \"My capacity_3!\" -> \"mycapacity3fsku\"."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b195eae8",
+   "metadata": {},
+   "source": [
+    "### Import the library and set the initial parameters"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1344e286",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import sempy_labs as labs\n",
+    "import sempy_labs.admin as admin\n",
+    "\n",
+    "azure_subscription_id = '' # Enter your Azure subscription ID\n",
+    "resource_group = '' # Enter the name of the resource group (to be used to create the new F skus)\n",
+    "\n",
+    "key_vault_uri = '', # Enter your key vault URI\n",
+    "key_vault_tenant_id = '', # Enter the key vault secret storig your Tenant ID\n",
+    "key_vault_client_id = '', # Enter the key vault secret storig your Client ID (Applciation ID)\n",
+    "key_vault_client_secret = '' # Enter the key vault secret storig your Client Secret"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "5a3fe6e8-b8aa-4447-812b-7931831e07fe",
+   "metadata": {
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "source": [
+    "### Migrate a single P SKU -> F SKU\n",
+    "Set the 'capacities' parameter to the single P SKU."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "3655dd88",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with labs.service_principal_authentication(\n",
+    "    key_vault_uri=key_vault_uri, \n",
+    "    key_vault_tenant_id=key_vault_tenant_id,\n",
+    "    key_vault_client_id=key_vault_client_id,\n",
+    "    key_vault_client_secret=key_vault_client_secret):\n",
+    "\n",
+    "    labs.migrate_capacities(\n",
+    "        azure_subscription_id = azure_subscription_id,\n",
+    "        resource_group = resource_group,\n",
+    "        capacities = 'CapacityA',\n",
+    "        p_sku_only = True,\n",
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "175a59b8",
+   "metadata": {},
+   "source": [
+    "### Migrate a list of P SKUs to F SKUs\n",
+    "Set the 'capacities' parameter to a list of P SKUs."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "3a7a80ec",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with labs.service_principal_authentication(\n",
+    "    key_vault_uri=key_vault_uri, \n",
+    "    key_vault_tenant_id=key_vault_tenant_id,\n",
+    "    key_vault_client_id=key_vault_client_id,\n",
+    "    key_vault_client_secret=key_vault_client_secret):\n",
+    "\n",
+    "    labs.migrate_capacities(\n",
+    "        azure_subscription_id = azure_subscription_id,\n",
+    "        resource_group = resource_group,\n",
+    "        capacities = ['CapacityA', 'CapacityB', 'CapacityC'],\n",
+    "        p_sku_only = True,\n",
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "30438799",
+   "metadata": {},
+   "source": [
+    "### Migrate all P SKUs to F SKUs\n",
+    "Set the 'capacities' parameter to None."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "315c2dc7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with labs.service_principal_authentication(\n",
+    "    key_vault_uri=key_vault_uri, \n",
+    "    key_vault_tenant_id=key_vault_tenant_id,\n",
+    "    key_vault_client_id=key_vault_client_id,\n",
+    "    key_vault_client_secret=key_vault_client_secret):\n",
+    "\n",
+    "    labs.migrate_capacities(\n",
+    "        azure_subscription_id = azure_subscription_id,\n",
+    "        resource_group = resource_group,\n",
+    "        capacities = None,\n",
+    "        p_sku_only = True,\n",
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1d8e73b2",
+   "metadata": {},
+   "source": [
+    "### Migrate a list of P SKUs to F SKUs; associate each capacity with a specific resource group\n",
+    "This process ensures that each F SKU is created within the resource group specified in the resource_group_mapping dictionary."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "2854bf8a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "resource_group_mapping = {\n",
+    "    \"CapacityA\": \"ResourceGroupA\",\n",
+    "    \"CapacityB\": \"ResourceGroupA\",\n",
+    "    \"CapacityC\": \"ResourceGroupB\",\n",
+    "}\n",
+    "\n",
+    "with labs.service_principal_authentication(\n",
+    "    key_vault_uri=key_vault_uri, \n",
+    "    key_vault_tenant_id=key_vault_tenant_id,\n",
+    "    key_vault_client_id=key_vault_client_id,\n",
+    "    key_vault_client_secret=key_vault_client_secret):\n",
+    "\n",
+    "    labs.migrate_capacities(\n",
+    "        azure_subscription_id = azure_subscription_id,\n",
+    "        resource_group = resource_group_mapping,\n",
+    "        capacities = ['CapacityA', 'CapacityB', 'CapacityC'],\n",
+    "        p_sku_only = True,\n",
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "c3f497c8",
+   "metadata": {},
+   "source": [
+    "### Migrate a single source capacity to a target capacity (target capacity already created)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a4f0b5a2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "source_capacity = '' # Enter the Source capacity name\n",
+    "target_capacity = '' # Enter the Target capacity name (already exists) \n",
+    "\n",
+    "admin.assign_workspaces_to_capacity(\n",
+    "    source_capacity=source_capacity,\n",
+    "    target_capacity=target_capacity,\n",
+    "    workspace=None,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e0db744b",
+   "metadata": {},
+   "source": [
+    "### Migrate a list of source capacities to target capacities (target capacity already created)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0e04d519",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "capacity_mapping = {\n",
+    "    \"capacitya\": \"capacityanew\", # Format is \"Source SKU\": \"Target SKU\"\n",
+    "    \"capacityb\": \"capacitybnew\",\n",
+    "    \"capacityc\": \"capacitycnew\",\n",
+    "}\n",
+    "\n",
+    "capacities = list(capacity_mapping.keys())\n",
+    "\n",
+    "for capacity in capacities:\n",
+    "    admin.assign_workspaces_to_capacity(\n",
+    "        source_capacity=capacity,\n",
+    "        target_capacity=capacity_mapping.get(capacity),\n",
+    "        workspace=None,\n",
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "67787c3a",
+   "metadata": {},
+   "source": [
+    "### Migrate a Fabric Trial Capacity (FT1) to a Fabric Capacity (F SKU)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4efb55b2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with labs.service_principal_authentication(\n",
+    "    key_vault_uri=key_vault_uri, \n",
+    "    key_vault_tenant_id=key_vault_tenant_id,\n",
+    "    key_vault_client_id=key_vault_client_id,\n",
+    "    key_vault_client_secret=key_vault_client_secret):\n",
+    "\n",
+    "    labs.migrate_fabric_trial_capacity(\n",
+    "        azure_subscription_id = azure_subscription_id,\n",
+    "        resource_group = resource_group,\n",
+    "        source_capacity = '', # The name of the Trial capacity.\n",
+    "        target_capacity = '', # The name of Fabric capacity (if it does not exist it will be created).\n",
+    "        target_capacity_sku = \"F64\", # Defaults to F64 but can specify the required SKU.\n",
+    "        target_capacity_admin_members = None, # Setting this to None will use the same admin members as the Trial capacity.\n",
+    "    )"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernel_info": {
+   "name": "synapse_pyspark"
+  },
+  "kernelspec": {
+   "display_name": "Synapse PySpark",
+   "language": "Python",
+   "name": "synapse_pyspark"
+  },
+  "language_info": {
+   "name": "python"
+  },
+  "microsoft": {
+   "language": "python"
+  },
+  "nteract": {
+   "version": "nteract-front-end@1.0.0"
+  },
+  "spark_compute": {
+   "compute_id": "/trident/default"
+  },
+  "synapse_widget": {
+   "state": {},
+   "version": "0.1"
+  },
+  "widgets": {}
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

semantic_link_labs-0.9.0/notebooks/Semantic Model Management.ipynb

@@ -0,0 +1,144 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "5c27dfd1-4fe0-4a97-92e6-ddf78889aa93",
+   "metadata": {
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "source": [
+    "### Install the latest .whl package\n",
+    "\n",
+    "Check [here](https://pypi.org/project/semantic-link-labs/) to see the latest version."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d5cae9db-cef9-48a8-a351-9c5fcc99645c",
+   "metadata": {
+    "jupyter": {
+     "outputs_hidden": true,
+     "source_hidden": false
+    },
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "outputs": [],
+   "source": [
+    "%pip install semantic-link-labs"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b195eae8",
+   "metadata": {},
+   "source": [
+    "### Import the library and necessary packages"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1344e286",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import sempy_labs as labs\n",
+    "source_dataset = '' # Name of the semantic model to backup\n",
+    "target_dataset = '' # Name of the semantic model to restore\n",
+    "source_workspace = '' # Name of the workspace in which the semantic model resides\n",
+    "target_workspace = '' # Destination workspace of the semantic model\n",
+    "source_file_path = '' # Name/path of the backup file to create\n",
+    "target_file_path = '' # Name/path of the backup file to be copied to the target workspace\n",
+    "storage_account = '' # Name of the ADLS Gen2 storage account associated with both source & target workspaces"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "d4f5356a",
+   "metadata": {},
+   "source": [
+    "#### Prerequisites\n",
+    "* [Create an ADLS Gen2 storage account (in the Azure Portal)](https://learn.microsoft.com/azure/storage/common/storage-account-create?tabs=azure-portal)\n",
+    "* Assign the ADLS Gen2 storage account to both source and target workspaces\n",
+    "    * Navigate to your workspace.\n",
+    "    * Select 'Workspace settings'.\n",
+    "    * Select 'Azure connections'.\n",
+    "    * Within 'Azure Data Lake Gen2 Storage' click 'Configure'.\n",
+    "    * Enter your Subscription, Resource Group and Storage Account.\n",
+    "    * Click 'Save'.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "55e5ca67",
+   "metadata": {},
+   "source": [
+    "### Backup, copy and restore a semantic model to a new workspace"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5a985c1f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "labs.backup_semantic_model(\n",
+    "    dataset=source_dataset,\n",
+    "    file_path=source_file_path,\n",
+    "    workspace=source_workspace,\n",
+    ")\n",
+    "labs.copy_semantic_model_backup_file(\n",
+    "    source_workspace=source_workspace,\n",
+    "    target_workspace=target_workspace,\n",
+    "    source_file_name=source_file_path,\n",
+    "    target_file_name=target_file_path,\n",
+    "    storage_account=storage_account,\n",
+    ")\n",
+    "labs.restore_semantic_model(\n",
+    "    dataset=target_dataset,\n",
+    "    file_path=target_file_path,\n",
+    "    workspace=target_workspace,\n",
+    ")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernel_info": {
+   "name": "synapse_pyspark"
+  },
+  "kernelspec": {
+   "display_name": "Synapse PySpark",
+   "language": "Python",
+   "name": "synapse_pyspark"
+  },
+  "language_info": {
+   "name": "python"
+  },
+  "microsoft": {
+   "language": "python"
+  },
+  "nteract": {
+   "version": "nteract-front-end@1.0.0"
+  },
+  "spark_compute": {
+   "compute_id": "/trident/default"
+  },
+  "synapse_widget": {
+   "state": {},
+   "version": "0.1"
+  },
+  "widgets": {}
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}