msfabricpysdkcore 0.0.1__py3-none-any.whl

msfabricpysdkcore/long_running_operation.py

@@ -0,0 +1,81 @@
+import json 
+import requests
+from time import sleep
+
+class LongRunningOperation:
+    """Class to represent a workspace in Microsoft Fabric"""
+
+    def __init__(self, operation_id, auth) -> None:
+        self.operation_id = operation_id
+        self.auth = auth
+
+        self.state = self.get_operation_state()["status"]
+
+
+    def get_operation_results(self):
+        """Get the results of an operation"""
+        url = f"https://api.fabric.microsoft.com/v1/operations/{self.operation_id}/result"
+
+        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 operation results: {response.text}")
+            break
+
+        print(json.loads(response.text))
+        return json.loads(response.text)
+    
+    def get_operation_state(self):
+        """Get the state of an operation"""
+        url = f"https://api.fabric.microsoft.com/v1/operations/{self.operation_id}"
+
+        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 operation state: {response.text}")
+            break
+
+        print(json.loads(response.text))
+        return json.loads(response.text)    
+    
+    def wait_for_completion(self):
+        """Wait for the operation to complete"""
+        max_iter = 20
+        while self.state not in ('Succeeded', 'Failed'):
+            self.state = self.get_operation_state()["status"]
+            sleep(3)
+            if max_iter == 0:
+                raise Exception("Operation did not complete after 60 seconds")
+            max_iter -= 1
+        return self.state
+    
+
+def check_long_running_operation(headers, auth):
+    """Check the status of a long running operation"""
+    location = headers.get('Location', None)
+    operation_id = headers.get('x-ms-operation-id', None)
+    if location:
+        operation_id = location.split("/")[-1]
+    
+    if not operation_id:
+        print("Operation initiated, no operation id found")
+        return None
+    else:
+        print("Operation initiated, waiting for completion")
+        lro = LongRunningOperation(operation_id=operation_id, auth=auth)
+        lro.wait_for_completion()
+        print("Operation completed")
+    lro = LongRunningOperation(operation_id, auth)
+    return lro.wait_for_completion()

msfabricpysdkcore/onelakeshortcut.py

@@ -0,0 +1,55 @@
+import json 
+import requests
+from time import sleep
+
+class OneLakeShortcut:
+    """Class to represent a onelake shortcut in Microsoft Fabric"""
+
+    def __init__(self, name, path, workspace_id, item_id, target,
+                  auth) -> None:
+        
+        self.name = name
+        self.path = path
+        self.target = target
+        self.item_id = item_id
+        self.workspace_id = workspace_id
+
+        self.user_auth = auth
+
+    def __str__(self) -> str:
+        """Return a string representation of the workspace object"""
+        dict_ = {
+            'name': self.name,
+            'path': self.path,
+            'target': self.target,
+            'item_id': self.item_id,
+            'workspace_id': self.workspace_id,
+        }
+        return json.dumps(dict_, indent=2)
+    
+    def from_dict(short_dict, auth):
+        """Create OneLakeShortCut object from dictionary"""
+        return OneLakeShortcut(name=short_dict['name'],
+                               path=short_dict['path'], 
+                               target=short_dict['target'], 
+                               item_id=short_dict['itemId'], 
+                               workspace_id=short_dict['workspaceId'], 
+                               auth=auth)
+    
+    def delete(self):
+        """Delete the shortcut"""
+
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.workspace_id}/items/{self.item_id}/shortcuts/{self.path}/{self.name}"
+        for _ in range(10):
+            response = requests.delete(url=url, headers=self.user_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 deleting shortcut: {response.text}")
+            break
+
+        return response.status_code

msfabricpysdkcore/workspace.py

@@ -0,0 +1,481 @@
+import json 
+import requests
+from time import sleep
+from msfabricpysdkcore.item import Item
+from msfabricpysdkcore.long_running_operation import check_long_running_operation
+
+class Workspace:
+    """Class to represent a workspace in Microsoft Fabric"""
+
+    def __init__(self, id, display_name, description, type, auth, capacity_id = None) -> None:
+        self.id = id
+        self.display_name = display_name
+        self.description = description
+        self.type = type
+        self.capacity_id = capacity_id
+
+        self.auth = auth
+        
+    
+    def from_dict(dict,  auth):
+        """Create a Workspace object from a dictionary"""
+        return Workspace(id=dict['id'], display_name=dict['displayName'], description=dict['description'], type=dict['type'], capacity_id=dict.get('capacityId', None),
+                         auth=auth)
+    
+    def __str__(self) -> str:
+        """Return a string representation of the workspace object"""
+        dict_ = {
+            'id': self.id,
+            'display_name': self.display_name,
+            'description': self.description,
+            'type': self.type,
+            'capacity_id': self.capacity_id
+        }
+        return json.dumps(dict_, indent=2)
+    
+    def get_role_assignments(self):
+        """Get role assignments for the workspace"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/roleAssignments"
+
+        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 role assignments: {response.text}")
+            break
+
+        return json.loads(response.text)
+    
+    def delete(self):
+        """Delete the workspace"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}"
+
+        for _ in range(10):
+            response = requests.delete(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 deleting workspace: {response.text}")
+            break
+
+        return response.status_code
+    
+    # function to add workpace role assignment
+    def add_role_assignment(self, role, principal):
+        """Add a role assignment to the workspace"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/roleAssignments"
+
+        payload = {
+            'principal': principal,
+            'role': role
+        }
+
+        for _ in range(10):
+            response = requests.post(url=url, headers=self.auth.get_headers(), data=json.dumps(payload))
+            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 adding role assignments: {response.text}")
+            break
+
+        return response.status_code
+    
+
+    def delete_role_assignment(self, principal_id):
+        """Delete a role assignment from the workspace"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/roleAssignments/{principal_id}"
+
+        for _ in range(10):
+            response = requests.delete(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 deleting role assignments: {response.text}")
+            break
+
+        
+        return response.status_code
+    
+    def update(self, display_name = None, description = None):
+        """Update the workspace"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}"
+
+        body = dict()
+        if display_name:
+            body["displayName"] = display_name
+        if description:
+            body["description"] = description
+
+
+        for _ in range(10):
+            response = requests.patch(url=url, headers=self.auth.get_headers(), json=body)
+            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 updating workspace: {response.text}")
+            break
+
+        assert response.status_code == 200
+        if display_name:
+            self.display_name = display_name
+        if description:
+            self.description = description
+
+        return self
+
+    def update_role_assignment(self, role, principal_id):
+        """Update a role assignment in the workspace"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/roleAssignments/{principal_id}"
+        body = {
+            'role': role
+        }
+
+        for _ in range(10):
+            response = requests.patch(url=url, headers=self.auth.get_headers(), json=body)
+            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 updating role assignments: {response.text}")
+            break
+
+        return response.status_code
+    
+    def assign_to_capacity(self, capacity_id):
+        """Assign the workspace to a capacity"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/assignToCapacity"
+
+        body = {
+            'capacityId': capacity_id
+        }
+
+
+        for _ in range(10):
+            response = requests.post(url=url, headers=self.auth.get_headers(), json=body)
+            if response.status_code == 429:
+                print("Too many requests, waiting 10 seconds")
+                sleep(10)
+                continue
+            if response.status_code == 202:
+                check_long_running_operation( response.headers, self.auth)
+            if response.status_code not in (202, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error assigning capacity: {response.text}")
+            break
+
+        assert response.status_code == 202
+        self.capacity_id = capacity_id
+        return response.status_code
+    
+    def unassign_from_capacity(self):
+        """Unassign the workspace from a capacity"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/unassignFromCapacity"
+
+        for _ in range(10):
+            response = requests.post(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 == 202:
+                check_long_running_operation( response.headers, self.auth)
+            if response.status_code not in (202, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error unassigning capacity: {response.text}")
+            break
+
+        assert response.status_code == 202
+        self.capacity_id = None
+        return response.status_code
+    
+    def create_item(self, display_name, type, definition = None, description = None):
+        """Create an item in a workspace"""
+
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/items"
+
+        body = {
+            'displayName': display_name,
+            'type': type,
+            'definition': definition,
+            'description': description
+        }
+
+        for _ in range(10):
+            response = requests.post(url=url, headers=self.auth.get_headers(), json=body)
+            if response.status_code == 429:
+                print("Too many requests, waiting 10 seconds")
+                sleep(10)
+                continue
+            if response.status_code == 202:
+                check_long_running_operation( response.headers, self.auth)
+            if response.status_code not in (201, 202, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error creating item: {response.text}")
+            break
+        
+        item_dict = json.loads(response.text)
+        return Item.from_dict(item_dict, auth=self.auth)
+        
+
+    def get_item(self, item_id):
+        # GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}
+        """Get an item from a workspace"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/items/{item_id}"
+
+        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 capacity: {response.text}")
+            break
+        
+        item_dict = json.loads(response.text)
+        return Item.from_dict(item_dict, auth=self.auth)
+
+    def delete_item(self, item_id):
+        """Delete an item from a workspace"""
+        return self.get_item(item_id).delete()
+
+    def list_items(self):
+        """List items in a workspace"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/items"
+
+        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 listing items: {response.text}")
+            break
+        items = json.loads(response.text)["value"]
+        return [Item.from_dict(item, auth=self.auth) for item in items]
+    
+    def get_item_definition(self, item_id):
+        """Get the definition of an item from a workspace"""
+        return self.get_item(item_id).get_definition()
+    
+    def update_item(self, item_id, display_name = None, description = None):
+        """Update an item in a workspace"""
+        return self.get_item(item_id=item_id).update(display_name=display_name, description=description)
+    
+    def update_item_definition(self, item_id, definition):
+        """Update the definition of an item in a workspace"""
+        return self.get_item(item_id=item_id).update_definition(definition=definition)
+    
+    def create_shortcut(self, item_id, path, name, target):
+        return self.get_item(item_id=item_id).create_shortcut(path=path, name=name, target=target)
+    
+    def get_shortcut(self, item_id, path, name):
+        return self.get_item(item_id=item_id).get_shortcut(path=path, name=name)
+    
+    def delete_shortcut(self, item_id, path, name):
+        return self.get_item(item_id=item_id).delete_shortcut(path=path, name=name)
+    
+    def run_on_demand_item_job(self, item_id, job_type, execution_data = None):
+        return self.get_item(item_id=item_id).run_on_demand_job(job_type=job_type, execution_data = execution_data)
+    
+    def get_item_job_instance(self, item_id, job_instance_id):
+        return self.get_item(item_id=item_id).get_item_job_instance(job_instance_id=job_instance_id)
+    
+    def cancel_item_job_instance(self, item_id, job_instance_id):
+        return self.get_item(item_id=item_id).cancel_item_job_instance(job_instance_id=job_instance_id)
+    
+    def git_connect(self, git_provider_details):
+        """Connect git"""
+        # POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/connect
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/git/connect"
+
+        payload = {
+            'gitProviderDetails': git_provider_details
+        }
+
+        for _ in range(10):
+            response = requests.post(url=url, headers=self.auth.get_headers(), json=payload)
+            if response.status_code == 429:
+                print("Too many requests, waiting 10 seconds")
+                sleep(10)
+                continue
+            if response.status_code not in (200, 204, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error connecting git: {response.text}")
+            break
+        return response.status_code
+
+    def git_disconnect(self):
+        """Disconnect git"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/git/disconnect"
+
+        for _ in range(10):
+            response = requests.post(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, 204, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error disconnecting git: {response.text}")
+            break
+        return response.status_code
+
+    def git_initialize_connection(self, initialization_strategy):
+    #        POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/initializeConnection
+        """Initialize git connection"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/git/initializeConnection"
+
+        body = {'initializeGitConnectionRequest':initialization_strategy}
+            
+        for _ in range(10):
+            response = requests.post(url=url, headers=self.auth.get_headers(), json=body)
+            if response.status_code == 429:
+                print("Too many requests, waiting 10 seconds")
+                sleep(10)
+                continue
+            if response.status_code == 202:
+                check_long_running_operation( response.headers, self.auth)
+            if response.status_code not in (200, 202, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error initializing connection: {response.text}")
+            break
+        return response.status_code
+    
+    def git_get_status(self):
+        """Get git connection status"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/git/status"
+
+        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 == 202:
+                check_long_running_operation( response.headers, self.auth)
+            if response.status_code not in (200, 202, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error getting git connection status: {response.text}")
+            break
+        return json.loads(response.text)
+    
+    def git_get_connection(self):
+        """Get git connection info"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/git/connection"
+
+        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 git connection info: {response.text}")
+            break
+        return json.loads(response.text)
+    
+    def commit_to_git(self, mode, comment=None, items=None, workspace_head=None):
+        # POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/commitToGit
+
+        """Commit to git"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/git/commitToGit"
+
+        body = {
+            'mode': mode
+        }
+
+        if comment:
+            body['comment'] = comment
+        if items:
+            body['items'] = items
+        if workspace_head:
+            body['workspaceHead'] = workspace_head
+
+        for _ in range(10):
+            response = requests.post(url=url, headers=self.auth.get_headers(), json=body)
+            if response.status_code == 429:
+                print("Too many requests, waiting 10 seconds")
+                sleep(10)
+                continue
+            if response.status_code == 202:
+                check_long_running_operation( response.headers, self.auth)
+            if response.status_code not in (200, 202, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error committing to git: {response.text}")
+            break
+
+        return response.status_code
+
+    def update_from_git(self, remote_commit_hash, conflict_resolution = None, options = None, workspace_head = None):
+        # POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/updateFromGit
+        """Update from git"""
+        url = f"https://api.fabric.microsoft.com/v1/workspaces/{self.id}/git/updateFromGit"
+
+        body = {
+            "remoteCommitHash" : remote_commit_hash
+        }
+
+        if conflict_resolution:
+            body['conflictResolution'] = conflict_resolution
+        if options:
+            body['options'] = options
+        if workspace_head:
+            body['workspaceHead'] = workspace_head
+
+        for _ in range(10):
+            response = requests.post(url=url, headers=self.auth.get_headers(), json=body)
+            if response.status_code == 429:
+                print("Too many requests, waiting 10 seconds")
+                sleep(10)
+                continue
+            if response.status_code == 202:
+                check_long_running_operation( response.headers, self.auth)
+
+            if response.status_code not in (200, 202, 429):
+                print(response.status_code)
+                print(response.text)
+                raise Exception(f"Error updating from git: {response.text}")
+            break
+
+        return response.status_code

msfabricpysdkcore-0.0.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Andreas J. Rederer
+
+    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