msfabricpysdkcore 0.0.2__tar.gz → 0.0.4__tar.gz

{msfabricpysdkcore-0.0.2 → msfabricpysdkcore-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: msfabricpysdkcore
-Version: 0.0.2
+Version: 0.0.4
 Summary: A Python SDK for Microsoft Fabric
 Author: Andreas Rederer
 Project-URL: Homepage, https://github.com/DaSenf1860/ms-fabric-sdk-core
@@ -13,9 +13,9 @@ License-File: LICENSE
 Requires-Dist: requests>=2.30.0
 Requires-Dist: azure-identity>=1.15.0
 
-# A Python SDK for Microsoft Fabric
+# Python SDK for Microsoft Fabric
 
-This is a Python SDK for Microsoft Fabric. It is a wrapper around the REST APIs of Fabric*.
+This is a Python SDK for Microsoft Fabric. It is a wrapper around the REST APIs (v1) of Fabric*.
 
 ![Python hugging a F](assets/fabricpythontransparent.png)
 
@@ -29,24 +29,35 @@ Additionally it brings some extra features like:
 - Retry logic when hitting the API rate limits
 - Referencing objects by name instead of ID
 - More granular objects, e.g. a Workspace and Item object instead of referencing IDs all the time
-- Do bulk operations**
-- Pagination support**
-
-Currently it supports all Core APIs, i.e.:
-- [Capacities](#working-with-capacities)
-- [Git](#working-with-git)
-- [Items](#working-with-items)
-- [Job Scheduler](#working-with-job-scheduler)
-- Long Running Operations
-- [OneLakeShortcuts](#working-with-one-lake-shortcuts)
-- [Workspaces](#working-with-workspaces)
-
-It is planned to support also the Admin and Lakehouse APIs and new APIs which are not released yet.
+- Do bulk operations (see [Usage Patterns](usage_patterns.md))
+- Pagination support
+
+See the latest release notes [here](releasenotes/release_notes.md).
+
+Currently it supports all Core APIs, Admin APIs and Lakehouse APIs, i.e.:
+- Core APIs
+  - [Capacities](#working-with-capacities)
+  - [Git](#working-with-git)
+  - [Items](#working-with-items)
+  - [Job Scheduler](#working-with-job-scheduler)
+  - Long Running Operations
+  - [OneLakeShortcuts](#working-with-one-lake-shortcuts)
+  - [Workspaces](#working-with-workspaces)
+- Lakehouse APIs
+  - [Tables](#tables)
+- Admin APIs
+  - [Domains](#admin-api-for-domains)
+  - [Items](#admin-api-for-items)
+  - [Tenants](#admin-api-for-tenants)
+  - [Users](#admin-api-for-users)
+  - [Workspaces](#admin-api-for-workspaces)
+
+It is planned to support also the APIs of the user experiences and new APIs which are not released yet.
+Also we have plans to support APIs to interact with Fabric capacities on the Azure Side.
 Eventually Power BI APIs like the Scanner API will be covered as well.
 
 *Because this SDK uses the API in the background, all limitations and restrictions of the API apply to this SDK as well. This includes rate limits, permissions, etc.
 
-**These features are not yet implemented but are planned for the near future.
 
 
 
@@ -160,11 +171,16 @@ ws.delete_role_assignment(principal_id = "abadfbafb")
 
 ```python
 
+
+capacity_object = fc.get_capacity(capacity_id = "0129389012u8938491") 
+#or 
+capacity_object = fc.get_capacity(capacity_name = "sandboxcapacitygermanywc") 
+
 # Assign a capaycity to a workspace
 fc.assign_to_capacity(workspace_id=workspace_id,
-                      capacity_id="capacityid123123")
+                      capacity_id=capacity_object.id)
 # or
-ws.assign_to_capacity(capacity_id="capacityid123123")      
+ws.assign_to_capacity(capacity_id=capacity_object.id)      
 
 # Unassign from capacity
 fc.unassign_from_capacity(workspace_id=ws.id)
@@ -359,6 +375,172 @@ item.cancel_item_job_instance(job_instance_id="job_instance_id")
 
 ```
 
+### Tables
+
+
+
+```python
+# List tables in a Lakehouse
+
+from msfabricpysdkcore import FabricClientCore
+
+fc = FabricClientCore()
+ws = fc.get_workspace_by_name("testworkspace")
+lakehouse = ws.get_item_by_name(item_name="lakehouse1", item_type="Lakehouse")
+table_list = lakehouse.list_tables()
+# or
+table_list = ws.list_tables(item_id = "someitemid")
+# or
+table_list = fc.list_tables(workspace_id = "someworkspaceid", item_id = "someitemid")
+
+
+# Load a file (like a csv) into a Lakehouse table
+
+lakehouse.load_table(table_name="testtable", path_type= "File", relative_path="Files/folder1/titanic.csv")
+# or
+ws.load_table(item_id = "someitemid", table_name="testtable",
+              path_type= "File", relative_path="Files/folder1/titanic.csv")
+# or
+fc.load_table(workspace_id = "someworkspaceid", item_id = "someitemid", table_name="testtable",
+              path_type= "File", relative_path="Files/folder1/titanic.csv")
+
+```
+
+### Admin API for Workspaces
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+
+# List workspaces
+ws = fca.list_workspaces(name="testworkspace")[0]
+
+# Get workspace
+ws = fca.get_workspace(workspace_id="workspace_id")
+
+# Get workspace access details
+
+ws_access = fca.get_workspace_access_details("workspace_id")
+# or
+ws_access = ws.get_access_details()
+```
+
+### Admin API for Users
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# Get access entities
+
+user_id = 'b4fuhaidc2'
+access_entities = fca.get_access_entities(user_id, type="Notebook")
+
+```
+
+### Admin API for Tenants
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# Get tenant settings
+
+tenant_settings = fca.get_tenant_settings()
+
+# Get capacity tenant settings overrides
+
+overrides = fca.get_capacities_tenant_settings_overrides()
+
+```
+
+### Admin API for Items
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# List items
+
+item_list = fca.list_items(workspace_id="wsid")
+
+# Get item
+
+item = fca.get_item(workspace_id="wsid", item_id=item_list[0].id)
+# or
+item = ws.get_item(item_id=item_list[0].id)
+
+# Get item access details
+
+item_access = fca.get_item_access_details(workspace_id="wsid", item_id=item_list[0].id)
+#or
+item_access = ws.get_item_access_details(item_id=item_list[0].id)
+# or
+item_access = item.get_access_details()
+
+```
+
+### Admin API for Domains
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# Create domain
+domain_name = "sdktestdomains"
+domain = fca.create_domain(display_name=domain_name)
+
+# Get domain by name
+domain_clone = fca.get_domain_by_name(domain_name)
+
+# Get domain by id
+domain_clone = fca.get_domain_by_id(domain.id)
+
+# List domains
+domains = fca.list_domains()
+
+# Update domain
+domain_new_name = "sdktestdomains2"
+domain_clone = fca.update_domain(domain.id, display_name=domain_new_name)
+
+# Assign domain workspaces by Ids
+fca.assign_domain_workspaces_by_ids(domain.id, ["workspace_id_1", "workspace_id_2"])
+
+# List domain workspaces
+workspaces = fca.list_domain_workspaces(domain.id, workspace_objects=True)
+
+# Unassign domain workspaces by ids
+status_code = fca.unassign_domain_workspaces_by_ids(domain.id, ["workspace_id_1", "workspace_id_2"])
+
+# Assign domain workspaces by capacities
+status_code = fca.assign_domain_workspaces_by_capacities(domain.id, ["cap_id1", "cap_id2"])
+
+# Unassign all domain workspaces
+status_code = fca.unassign_all_domain_workspaces(domain.id)
+
+# Assign domain workspaces by principals
+principal1 = {'id': '6edbsdfbfdgdf656', 'type': 'User'}
+principal2 = {'id': '6eyxcbyyxc57', 'type': 'User'}
+
+status_code = fca.assign_domains_workspaces_by_principals(domain.id, [principal1, principal2], wait_for_completion=True)
+
+# Role assignments bulk assign
+
+principals = [principal, principal_2]
+status_code = fca.role_assignments_bulk_assign(domain.id, "Contributors", principals)
+
+# Role assignments bulk unassign
+status_code = fca.role_assignments_bulk_unassign(domain.id, "Contributors", [principal_2])
+
+# Delete domain
+status_code = fca.delete_domain(domain.id)
+```
 
 
 Note: This SDK is not an official SDK from Microsoft. It is a community project and not supported by Microsoft. Use it at your own risk.

{msfabricpysdkcore-0.0.2 → msfabricpysdkcore-0.0.4}/README.md

@@ -1,6 +1,6 @@
-# A Python SDK for Microsoft Fabric
+# Python SDK for Microsoft Fabric
 
-This is a Python SDK for Microsoft Fabric. It is a wrapper around the REST APIs of Fabric*.
+This is a Python SDK for Microsoft Fabric. It is a wrapper around the REST APIs (v1) of Fabric*.
 
 ![Python hugging a F](assets/fabricpythontransparent.png)
 
@@ -14,24 +14,35 @@ Additionally it brings some extra features like:
 - Retry logic when hitting the API rate limits
 - Referencing objects by name instead of ID
 - More granular objects, e.g. a Workspace and Item object instead of referencing IDs all the time
-- Do bulk operations**
-- Pagination support**
-
-Currently it supports all Core APIs, i.e.:
-- [Capacities](#working-with-capacities)
-- [Git](#working-with-git)
-- [Items](#working-with-items)
-- [Job Scheduler](#working-with-job-scheduler)
-- Long Running Operations
-- [OneLakeShortcuts](#working-with-one-lake-shortcuts)
-- [Workspaces](#working-with-workspaces)
-
-It is planned to support also the Admin and Lakehouse APIs and new APIs which are not released yet.
+- Do bulk operations (see [Usage Patterns](usage_patterns.md))
+- Pagination support
+
+See the latest release notes [here](releasenotes/release_notes.md).
+
+Currently it supports all Core APIs, Admin APIs and Lakehouse APIs, i.e.:
+- Core APIs
+  - [Capacities](#working-with-capacities)
+  - [Git](#working-with-git)
+  - [Items](#working-with-items)
+  - [Job Scheduler](#working-with-job-scheduler)
+  - Long Running Operations
+  - [OneLakeShortcuts](#working-with-one-lake-shortcuts)
+  - [Workspaces](#working-with-workspaces)
+- Lakehouse APIs
+  - [Tables](#tables)
+- Admin APIs
+  - [Domains](#admin-api-for-domains)
+  - [Items](#admin-api-for-items)
+  - [Tenants](#admin-api-for-tenants)
+  - [Users](#admin-api-for-users)
+  - [Workspaces](#admin-api-for-workspaces)
+
+It is planned to support also the APIs of the user experiences and new APIs which are not released yet.
+Also we have plans to support APIs to interact with Fabric capacities on the Azure Side.
 Eventually Power BI APIs like the Scanner API will be covered as well.
 
 *Because this SDK uses the API in the background, all limitations and restrictions of the API apply to this SDK as well. This includes rate limits, permissions, etc.
 
-**These features are not yet implemented but are planned for the near future.
 
 
 
@@ -145,11 +156,16 @@ ws.delete_role_assignment(principal_id = "abadfbafb")
 
 ```python
 
+
+capacity_object = fc.get_capacity(capacity_id = "0129389012u8938491") 
+#or 
+capacity_object = fc.get_capacity(capacity_name = "sandboxcapacitygermanywc") 
+
 # Assign a capaycity to a workspace
 fc.assign_to_capacity(workspace_id=workspace_id,
-                      capacity_id="capacityid123123")
+                      capacity_id=capacity_object.id)
 # or
-ws.assign_to_capacity(capacity_id="capacityid123123")      
+ws.assign_to_capacity(capacity_id=capacity_object.id)      
 
 # Unassign from capacity
 fc.unassign_from_capacity(workspace_id=ws.id)
@@ -344,7 +360,173 @@ item.cancel_item_job_instance(job_instance_id="job_instance_id")
 
 ```
 
+### Tables
+
+
+
+```python
+# List tables in a Lakehouse
+
+from msfabricpysdkcore import FabricClientCore
+
+fc = FabricClientCore()
+ws = fc.get_workspace_by_name("testworkspace")
+lakehouse = ws.get_item_by_name(item_name="lakehouse1", item_type="Lakehouse")
+table_list = lakehouse.list_tables()
+# or
+table_list = ws.list_tables(item_id = "someitemid")
+# or
+table_list = fc.list_tables(workspace_id = "someworkspaceid", item_id = "someitemid")
+
+
+# Load a file (like a csv) into a Lakehouse table
+
+lakehouse.load_table(table_name="testtable", path_type= "File", relative_path="Files/folder1/titanic.csv")
+# or
+ws.load_table(item_id = "someitemid", table_name="testtable",
+              path_type= "File", relative_path="Files/folder1/titanic.csv")
+# or
+fc.load_table(workspace_id = "someworkspaceid", item_id = "someitemid", table_name="testtable",
+              path_type= "File", relative_path="Files/folder1/titanic.csv")
+
+```
+
+### Admin API for Workspaces
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+
+# List workspaces
+ws = fca.list_workspaces(name="testworkspace")[0]
+
+# Get workspace
+ws = fca.get_workspace(workspace_id="workspace_id")
+
+# Get workspace access details
+
+ws_access = fca.get_workspace_access_details("workspace_id")
+# or
+ws_access = ws.get_access_details()
+```
+
+### Admin API for Users
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# Get access entities
+
+user_id = 'b4fuhaidc2'
+access_entities = fca.get_access_entities(user_id, type="Notebook")
+
+```
+
+### Admin API for Tenants
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# Get tenant settings
+
+tenant_settings = fca.get_tenant_settings()
+
+# Get capacity tenant settings overrides
+
+overrides = fca.get_capacities_tenant_settings_overrides()
+
+```
+
+### Admin API for Items
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# List items
+
+item_list = fca.list_items(workspace_id="wsid")
+
+# Get item
+
+item = fca.get_item(workspace_id="wsid", item_id=item_list[0].id)
+# or
+item = ws.get_item(item_id=item_list[0].id)
+
+# Get item access details
+
+item_access = fca.get_item_access_details(workspace_id="wsid", item_id=item_list[0].id)
+#or
+item_access = ws.get_item_access_details(item_id=item_list[0].id)
+# or
+item_access = item.get_access_details()
+
+```
+
+### Admin API for Domains
+
+```python
+from msfabricpysdkcore import FabricClientAdmin
+
+fca = FabricClientAdmin()
+
+# Create domain
+domain_name = "sdktestdomains"
+domain = fca.create_domain(display_name=domain_name)
+
+# Get domain by name
+domain_clone = fca.get_domain_by_name(domain_name)
+
+# Get domain by id
+domain_clone = fca.get_domain_by_id(domain.id)
+
+# List domains
+domains = fca.list_domains()
+
+# Update domain
+domain_new_name = "sdktestdomains2"
+domain_clone = fca.update_domain(domain.id, display_name=domain_new_name)
+
+# Assign domain workspaces by Ids
+fca.assign_domain_workspaces_by_ids(domain.id, ["workspace_id_1", "workspace_id_2"])
+
+# List domain workspaces
+workspaces = fca.list_domain_workspaces(domain.id, workspace_objects=True)
+
+# Unassign domain workspaces by ids
+status_code = fca.unassign_domain_workspaces_by_ids(domain.id, ["workspace_id_1", "workspace_id_2"])
+
+# Assign domain workspaces by capacities
+status_code = fca.assign_domain_workspaces_by_capacities(domain.id, ["cap_id1", "cap_id2"])
+
+# Unassign all domain workspaces
+status_code = fca.unassign_all_domain_workspaces(domain.id)
+
+# Assign domain workspaces by principals
+principal1 = {'id': '6edbsdfbfdgdf656', 'type': 'User'}
+principal2 = {'id': '6eyxcbyyxc57', 'type': 'User'}
+
+status_code = fca.assign_domains_workspaces_by_principals(domain.id, [principal1, principal2], wait_for_completion=True)
+
+# Role assignments bulk assign
+
+principals = [principal, principal_2]
+status_code = fca.role_assignments_bulk_assign(domain.id, "Contributors", principals)
+
+# Role assignments bulk unassign
+status_code = fca.role_assignments_bulk_unassign(domain.id, "Contributors", [principal_2])
+
+# Delete domain
+status_code = fca.delete_domain(domain.id)
+```
 
 
 Note: This SDK is not an official SDK from Microsoft. It is a community project and not supported by Microsoft. Use it at your own risk.
-Also the API is still in preview and might change. This SDK is not yet feature complete and might not cover all APIs yet. Feel free to contribute to this project to make it better.
+Also the API is still in preview and might change. This SDK is not yet feature complete and might not cover all APIs yet. Feel free to contribute to this project to make it better.

msfabricpysdkcore-0.0.4/msfabricpysdkcore/__init__.py

@@ -0,0 +1,2 @@
+from .coreapi import FabricClientCore
+from .adminapi import FabricClientAdmin

msfabricpysdkcore-0.0.4/msfabricpysdkcore/admin_item.py

@@ -0,0 +1,106 @@
+import json
+from time import sleep
+
+import requests 
+
+
+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:
+        """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
+            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
+        """
+        self.id = id
+        self.type = type
+        self.name = name
+        self.workspace_id = workspace_id
+        self.state = state
+        self.description = description
+        self.last_updated_date = last_updated_date
+        self.capacity_id = capacity_id
+        self.creator_principal = creator_principal
+        self.auth = auth
+
+
+    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,
+            'workspace_id': self.workspace_id,
+            'state': self.state,
+            'description': self.description,
+            'last_updated_date': self.last_updated_date,
+            'capacity_id': self.capacity_id,
+            'creator_principal': self.creator_principal
+        }
+        return json.dumps(dict_, indent=2)
+
+    
+    def __repr__(self) -> str:
+        return self.__str__()
+    
+    def from_dict(item_dict, auth):
+        """Create Item object from dictionary
+        
+        Args:
+            item_dict (dict): The dictionary containing the item information
+            auth (Auth): The Auth object
+        Returns:
+            Item: The Item object"""
+        return AdminItem(
+            id = item_dict['id'],
+            type = item_dict['type'],
+            name = item_dict['name'],
+            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
+        )
+    
+    def get_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)