msfabricpysdkcore 0.0.13__tar.gz → 0.1.1__tar.gz

{msfabricpysdkcore-0.0.13 → msfabricpysdkcore-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: msfabricpysdkcore
-Version: 0.0.13
+Version: 0.1.1
 Summary: A Python SDK for Microsoft Fabric
 Author: Andreas Rederer
 Project-URL: Homepage, https://github.com/DaSenf1860/ms-fabric-sdk-core
@@ -24,7 +24,7 @@ They are designed to automate your Fabric processes.
 
 This SDK helps to interact with the Fabric APIs in a more Pythonic way.
 Additionally it brings some extra features like:
-- Authentication is handled for you (currently Azure CLI Authentication and Service Principal Authentication are supported, as well as Synapse Spark Authentication in Fabric Notebooks)
+- Authentication is handled for you (currently Azure CLI Authentication, Authentication from a Microsoft Fabric notebook and Service Principal Authentication are supported)
 - Waiting for completion of long running operations
 - Retry logic when hitting the API rate limits
 - Referencing objects by name instead of ID
@@ -85,6 +85,7 @@ from msfabricpysdkcore import FabricClientCore
 # Create a client
 
 # Either login with the Azure CLI first and initiate the client directly
+# This also works directly in a Microsoft Fabric notebook
 fc = FabricClientCore()
 
 # Or use a service principal (note that not all APIs are supported with service principal)
@@ -230,7 +231,7 @@ pipe = fc.get_deployment_pipeline(pipe_id)
 
 
 # Get deployment pipeline stages
-stages = fc.get_deployment_pipeline_stages(pipe_id)
+stages = fc.list_deployment_pipeline_stages(pipe_id)
 
 names = [stage.display_name for stage in stages]
 
@@ -238,7 +239,7 @@ dev_stage = [stage for stage in stages if stage.display_name == "Development"][0
 prod_stage = [stage for stage in stages if stage.display_name == "Production"][0]
 
 # Get deployment pipeline stages items
-items = fc.get_deployment_pipeline_stages_items(pipeline_id=pipe_id, stage_id=dev_stage.id)
+items = fc.list_deployment_pipeline_stages_items(pipeline_id=pipe_id, stage_id=dev_stage.id)
 
 
 items = [item for item in dev_stage.get_items() if item["itemDisplayName"] == 'cicdlakehouse']
@@ -312,11 +313,11 @@ item_list = ws.list_items()
 
 
 # Update an item
-fc.update_item(workspace_id="workspace_id", item_id="item_id" display_name="new_item_name", description = None)
+fc.update_item(workspace_id="workspace_id", item_id="item_id" display_name="new_item_name", description = None, return_item=True)
 # or
-ws.update_item(item_id="item_id", display_name="new_item_name", description = None)
+ws.update_item(item_id="item_id", display_name="new_item_name", description = None, return_item=True)
 # or
-item.update(display_name="new_item_name", description = None)
+item.update(display_name="new_item_name", description = None, return_item=True)
 
 
 # Delete an item
@@ -654,7 +655,7 @@ domains = fca.list_domains()
 
 # Update domain
 domain_new_name = "sdktestdomains2"
-domain_clone = fca.update_domain(domain.id, display_name=domain_new_name)
+domain_clone = fca.update_domain(domain.id, display_name=domain_new_name, return_item=True)
 
 # Assign domain workspaces by Ids
 fca.assign_domain_workspaces_by_ids(domain.id, ["workspace_id_1", "workspace_id_2"])

{msfabricpysdkcore-0.0.13 → msfabricpysdkcore-0.1.1}/README.md

@@ -9,7 +9,7 @@ They are designed to automate your Fabric processes.
 
 This SDK helps to interact with the Fabric APIs in a more Pythonic way.
 Additionally it brings some extra features like:
-- Authentication is handled for you (currently Azure CLI Authentication and Service Principal Authentication are supported, as well as Synapse Spark Authentication in Fabric Notebooks)
+- Authentication is handled for you (currently Azure CLI Authentication, Authentication from a Microsoft Fabric notebook and Service Principal Authentication are supported)
 - Waiting for completion of long running operations
 - Retry logic when hitting the API rate limits
 - Referencing objects by name instead of ID
@@ -70,6 +70,7 @@ from msfabricpysdkcore import FabricClientCore
 # Create a client
 
 # Either login with the Azure CLI first and initiate the client directly
+# This also works directly in a Microsoft Fabric notebook
 fc = FabricClientCore()
 
 # Or use a service principal (note that not all APIs are supported with service principal)
@@ -215,7 +216,7 @@ pipe = fc.get_deployment_pipeline(pipe_id)
 
 
 # Get deployment pipeline stages
-stages = fc.get_deployment_pipeline_stages(pipe_id)
+stages = fc.list_deployment_pipeline_stages(pipe_id)
 
 names = [stage.display_name for stage in stages]
 
@@ -223,7 +224,7 @@ dev_stage = [stage for stage in stages if stage.display_name == "Development"][0
 prod_stage = [stage for stage in stages if stage.display_name == "Production"][0]
 
 # Get deployment pipeline stages items
-items = fc.get_deployment_pipeline_stages_items(pipeline_id=pipe_id, stage_id=dev_stage.id)
+items = fc.list_deployment_pipeline_stages_items(pipeline_id=pipe_id, stage_id=dev_stage.id)
 
 
 items = [item for item in dev_stage.get_items() if item["itemDisplayName"] == 'cicdlakehouse']
@@ -297,11 +298,11 @@ item_list = ws.list_items()
 
 
 # Update an item
-fc.update_item(workspace_id="workspace_id", item_id="item_id" display_name="new_item_name", description = None)
+fc.update_item(workspace_id="workspace_id", item_id="item_id" display_name="new_item_name", description = None, return_item=True)
 # or
-ws.update_item(item_id="item_id", display_name="new_item_name", description = None)
+ws.update_item(item_id="item_id", display_name="new_item_name", description = None, return_item=True)
 # or
-item.update(display_name="new_item_name", description = None)
+item.update(display_name="new_item_name", description = None, return_item=True)
 
 
 # Delete an item
@@ -639,7 +640,7 @@ domains = fca.list_domains()
 
 # Update domain
 domain_new_name = "sdktestdomains2"
-domain_clone = fca.update_domain(domain.id, display_name=domain_new_name)
+domain_clone = fca.update_domain(domain.id, display_name=domain_new_name, return_item=True)
 
 # Assign domain workspaces by Ids
 fca.assign_domain_workspaces_by_ids(domain.id, ["workspace_id_1", "workspace_id_2"])

{msfabricpysdkcore-0.0.13 → msfabricpysdkcore-0.1.1}/msfabricpysdkcore/admin_item.py

@@ -1,29 +1,26 @@
 import json
-from time import sleep
-
-import requests 
+from msfabricpysdkcore.adminapi import FabricClientAdmin
 
 
 class AdminItem:
     """Class to represent a item in Microsoft Fabric"""
 
-    def __init__(self, id, type, name, workspace_id, state, description, last_updated_date, capacity_id, creator_principal, auth) -> None:
+    def __init__(self, id, type, name, workspace_id, state, description, last_updated_date, capacity_id, creator_principal, admin_client: FabricClientAdmin) -> None:
         """Constructor for the Item class
         
         Args:
             id (str): The ID of the item
             type (str): The type of the item
             name (str): The name of the item
-            workspace_id (str): The ID of the workspace
+            workspace_id (str): The ID of the workspace to which the item belongs
             state (str): The state of the item
             description (str): The description of the item
-            last_updated_date (str): The last updated date of the item
-            capacity_id (str): The ID of the capacity
-            creator_principal (dict): The creator principal of the item
-            auth (Auth): The Auth object
-        Returns:
-            Item: The Item object
+            last_updated_date (str): The date when the item was last updated
+            capacity_id (str): The
+            creator_principal (str): The principal who created the item
+            admin_client (FabricClientAdmin): The FabricClientAdmin object
         """
+
         self.id = id
         self.type = type
         self.name = name
@@ -33,7 +30,7 @@ class AdminItem:
         self.last_updated_date = last_updated_date
         self.capacity_id = capacity_id
         self.creator_principal = creator_principal
-        self.auth = auth
+        self.admin_client = admin_client
 
 
     def __str__(self) -> str:
@@ -59,55 +56,32 @@ class AdminItem:
     def __repr__(self) -> str:
         return self.__str__()
     
-    def from_dict(item_dict, auth):
+    def from_dict(item_dict, admin_client):
         """Create Item object from dictionary
         
         Args:
-            item_dict (dict): The dictionary containing the item information
-            auth (Auth): The Auth object
+            item_dict (dict): The dictionary containing the item details
+            admin_client (FabricClientAdmin): The FabricClientAdmin object
         Returns:
-            Item: The Item object"""
+            AdminItem: The AdminItem object
+        """
         return AdminItem(
             id = item_dict['id'],
             type = item_dict['type'],
-            name = item_dict['name'],
+            name = item_dict.get('name', None),
             workspace_id = item_dict['workspaceId'],
             state = item_dict['state'],
             description = item_dict.get('description', None),
             last_updated_date = item_dict['lastUpdatedDate'],
             capacity_id = item_dict['capacityId'],
             creator_principal = item_dict['creatorPrincipal'],
-            auth = auth
+            admin_client = admin_client
         )
-    
-    def get_item_access_details(self, type=None):
-        """Get the access details of the item
-        
-        Returns:
-            dict: The access details of the item"""
-        return self.list_item_access_details(type)
-        
+            
     def list_item_access_details(self, type=None):
         """Get the access details of the item
         
         Returns:
             dict: The access details of the item"""
         
-        url = f"https://api.fabric.microsoft.com/v1/admin/workspaces/{self.workspace_id}/items/{self.id}/users"
-
-        if type:
-            url += f"?type={self.type}"
-        
-        for _ in range(10):
-            response = requests.get(url=url, headers=self.auth.get_headers())
-            if response.status_code == 429:
-                print("Too many requests, waiting 10 seconds")
-                sleep(10)
-                continue
-            if response.status_code not in (200, 429):
-                print(response.status_code)
-                print(response.text)
-                raise Exception(f"Error getting item: {response.text}")
-            break
-        
-        return json.loads(response.text)
+        return self.admin_client.list_item_access_details(self.workspace_id, self.id, type)

msfabricpysdkcore-0.1.1/msfabricpysdkcore/admin_workspace.py

@@ -0,0 +1,99 @@
+import json
+from time import sleep
+
+from msfabricpysdkcore.admin_item import AdminItem 
+from msfabricpysdkcore.adminapi import FabricClientAdmin
+
+
+class AdminWorkspace:
+    """Class to represent a workspace in Microsoft Fabric"""
+
+    def __init__(self, id, type, name, state, capacity_id, admin_client:FabricClientAdmin) -> None:
+        """Constructor for the Workspace class
+
+        Args:
+            id (str): The ID of the workspace
+            type (str): The type of the workspace
+            name (str): The name of the workspace
+            state (str): The state of the workspace
+            capacity_id (str): The ID of the capacity
+            admin_client (FabricClientAdmin): The FabricClientAdmin object
+        Returns:
+            Workspace: The Workspace object
+        """
+        self.id = id
+        self.type = type
+        self.name = name
+        self.state = state
+        self.capacity_id = capacity_id
+        self.admin_client = admin_client
+
+
+    def __str__(self) -> str:
+        """Return a string representation of the workspace object
+        
+        Returns:
+            str: The string representation of the workspace object
+        """
+        dict_ = {
+            'id': self.id,
+            'type': self.type,
+            'name': self.name,
+            'state': self.state,
+            'capacity_id': self.capacity_id
+        }
+        return json.dumps(dict_, indent=2)
+
+    
+    def __repr__(self) -> str:
+        return self.__str__()
+    
+    def from_dict(item_dict, admin_client):
+        """Create Workspace object from dictionary
+
+        Args:
+            item_dict (dict): The dictionary representing the workspace
+            admin_client (FabricClientAdmin): The FabricClientAdmin object
+        Returns:
+            Workspace: The Workspace object
+        """
+        return AdminWorkspace(
+            id=item_dict['id'],
+            type=item_dict['type'],
+            name=item_dict['name'],
+            state=item_dict['state'],
+            capacity_id=item_dict['capacityId'],
+            admin_client=admin_client
+        )
+        
+    def list_workspace_access_details(self):
+        """Get the access details of the workspace
+
+        Returns:
+            dict: The access details of the workspace
+        """
+        return self.admin_client.list_workspace_access_details(self.id)
+    
+    # Items
+
+    def get_item(self, item_id, type = None):
+        """Get an item from the workspace
+        
+        Args:
+            item_id (str): The ID of the item
+            type (str): The type of the item
+        Returns:
+            AdminItem: The item object
+        """
+        return self.admin_client.get_item(self.id, item_id, type)
+    
+    def list_item_access_details(self, item_id, type=None):
+        """Get the access details of the item
+        
+        Args:
+            item_id (str): The ID of the item
+            type (str): The type of the item
+        Returns:
+            dict: The access details of the item
+        """
+        return self.admin_client.list_item_access_details(self.id, item_id, type)