Enhance sample scripts with improved docstrings and consistent string formatting

Author: areed1192

samples/use_available_features.py

@@ -1,3 +1,5 @@
+"""Demonstrates how to use the `AvailableFeatures` service."""
+
 from pprint import pprint
 from configparser import ConfigParser
 from powerbi.client import PowerBiClient
@@ -6,33 +8,29 @@
 config = ConfigParser()
 
 # Read the file.
-config.read('config/config.ini')
+config.read("config/config.ini")
 
 # Get the specified credentials.
-client_id = config.get('power_bi_api', 'client_id')
-redirect_uri = config.get('power_bi_api', 'redirect_uri')
-client_secret = config.get('power_bi_api', 'client_secret')
+client_id = config.get("power_bi_api", "client_id")
+redirect_uri = config.get("power_bi_api", "redirect_uri")
+client_secret = config.get("power_bi_api", "client_secret")
 
 # Initialize the Client.
 power_bi_client = PowerBiClient(
     client_id=client_id,
     client_secret=client_secret,
-    scope=['https://analysis.windows.net/powerbi/api/.default'],
+    scope=["https://analysis.windows.net/powerbi/api/.default"],
     redirect_uri=redirect_uri,
-    credentials='config/power_bi_state.jsonc'
+    credentials="config/power_bi_state.jsonc",
 )
 
 # Initialize the `AvailableFeatures` service.
 available_features_service = power_bi_client.available_features()
 
 # List all Available Features
-pprint(
-    available_features_service.get_available_features()
-)
+pprint(available_features_service.get_available_features())
 
 # List all Available Features
 pprint(
-    available_features_service.get_available_feature_by_name(
-        feature_name='embedTrial'
-    )
+    available_features_service.get_available_feature_by_name(feature_name="embedTrial")
 )

samples/use_capacities.py

@@ -1,3 +1,5 @@
+"""Demonstrates how to use the `Capacities` service."""
+
 from pprint import pprint
 from configparser import ConfigParser
 from powerbi.client import PowerBiClient
@@ -6,54 +8,46 @@
 config = ConfigParser()
 
 # Read the file.
-config.read('config/config.ini')
+config.read("config/config.ini")
 
 # Get the specified credentials.
-client_id = config.get('power_bi_api', 'client_id')
-redirect_uri = config.get('power_bi_api', 'redirect_uri')
-client_secret = config.get('power_bi_api', 'client_secret')
+client_id = config.get("power_bi_api", "client_id")
+redirect_uri = config.get("power_bi_api", "redirect_uri")
+client_secret = config.get("power_bi_api", "client_secret")
 
 # Initialize the Client.
 power_bi_client = PowerBiClient(
     client_id=client_id,
     client_secret=client_secret,
-    scope=['https://analysis.windows.net/powerbi/api/.default'],
+    scope=["https://analysis.windows.net/powerbi/api/.default"],
     redirect_uri=redirect_uri,
-    credentials='config/power_bi_state.jsonc'
+    credentials="config/power_bi_state.jsonc",
 )
 
 # Initialize the `Capacities` service.
 capacities_service = power_bi_client.capactities()
 
 # Get a list of the User's available capacities.
-pprint(
-    capacities_service.get_capacities()
-)
+pprint(capacities_service.get_capacities())
 
 # Get a list of the User's available capacities.
 pprint(
-    capacities_service.get_workloads(
-        capacity_id='890D018E-4B64-4BB1-97E5-BD5490373413'
-    )
+    capacities_service.get_workloads(capacity_id="890D018E-4B64-4BB1-97E5-BD5490373413")
 )
 
 # Grab a specific workload from a capacity.
 pprint(
     capacities_service.get_workload(
-        capacity_id='890D018E-4B64-4BB1-97E5-BD5490373413',
-        workload_name='my-workload'
+        capacity_id="890D018E-4B64-4BB1-97E5-BD5490373413", workload_name="my-workload"
     )
 )
 
 # Grab a specific workload from a capacity.
-pprint(
-    capacities_service.get_refreshables()
-)
+pprint(capacities_service.get_refreshables())
 
 # Get refreshables for a specific capacity.
 pprint(
     capacities_service.get_refreshables_for_capacity(
-        capacity_id='890D018E-4B64-4BB1-97E5-BD5490373413'.lower(),
-        top=10
+        capacity_id="890D018E-4B64-4BB1-97E5-BD5490373413".lower(), top=10
     )
 )

samples/use_client.py

@@ -1,24 +1,26 @@
+"""Demonstrates how to use the `PowerBiClient` class."""
+
 from configparser import ConfigParser
 from powerbi.client import PowerBiClient
 
 # Initialize the Parser.
 config = ConfigParser()
 
 # Read the file.
-config.read('config/config.ini')
+config.read("config/config.ini")
 
 # Get the specified credentials.
-client_id = config.get('power_bi_api', 'client_id')
-redirect_uri = config.get('power_bi_api', 'redirect_uri')
-client_secret = config.get('power_bi_api', 'client_secret')
+client_id = config.get("power_bi_api", "client_id")
+redirect_uri = config.get("power_bi_api", "redirect_uri")
+client_secret = config.get("power_bi_api", "client_secret")
 
 # Initialize the Client.
 power_bi_client = PowerBiClient(
     client_id=client_id,
     client_secret=client_secret,
-    scope=['https://analysis.windows.net/powerbi/api/.default'],
+    scope=["https://analysis.windows.net/powerbi/api/.default"],
     redirect_uri=redirect_uri,
-    credentials='config/power_bi_state.jsonc'
+    credentials="config/power_bi_state.jsonc",
 )
 
 # Initialize the `Dashboards` service.

samples/use_dashboards_service.py

@@ -1,3 +1,5 @@
+"""Demonstrates how to use the `Dashboards` service."""
+
 from pprint import pprint
 from configparser import ConfigParser
 from powerbi.client import PowerBiClient
@@ -6,108 +8,101 @@
 config = ConfigParser()
 
 # Read the file.
-config.read('config/config.ini')
+config.read("config/config.ini")
 
 # Get the specified credentials.
-client_id = config.get('power_bi_api', 'client_id')
-redirect_uri = config.get('power_bi_api', 'redirect_uri')
-client_secret = config.get('power_bi_api', 'client_secret')
+client_id = config.get("power_bi_api", "client_id")
+redirect_uri = config.get("power_bi_api", "redirect_uri")
+client_secret = config.get("power_bi_api", "client_secret")
 
 # Initialize the Client.
 power_bi_client = PowerBiClient(
     client_id=client_id,
     client_secret=client_secret,
-    scope=['https://analysis.windows.net/powerbi/api/.default'],
+    scope=["https://analysis.windows.net/powerbi/api/.default"],
     redirect_uri=redirect_uri,
-    credentials='config/power_bi_state.jsonc'
+    credentials="config/power_bi_state.jsonc",
 )
 
 # Initialize the `Dashboards` service.
 dashboard_service = power_bi_client.dashboards()
 
 # Add a dashboard to our Workspace.
-dashboard_service.add_dashboard(name='tradingRobot')
+dashboard_service.add_dashboard(name="tradingRobot")
 
 # Get all the dashboards in our Org.
 pprint(dashboard_service.get_dashboards())
 
 # Grab all the dashboards for a specific workspace.
 pprint(
-    dashboard_service.get_dashboard(
-        dashboard_id='bf2c7d16-ec7b-40a2-ab56-f8797fdc5fb8'
-    )
+    dashboard_service.get_dashboard(dashboard_id="bf2c7d16-ec7b-40a2-ab56-f8797fdc5fb8")
 )
 
 # Add a dashboard to a specific workspace.
 pprint(
     dashboard_service.add_dashboard_in_group(
-        name='my_new_dashboard',
-        group_id='f78705a2-bead-4a5c-ba57-166794b05c78'
+        name="my_new_dashboard", group_id="f78705a2-bead-4a5c-ba57-166794b05c78"
     )
 )
 
 # Grab all the dashboards for a specific workspace.
 pprint(
     dashboard_service.get_group_dashboards(
-        group_id='f78705a2-bead-4a5c-ba57-166794b05c78'
+        group_id="f78705a2-bead-4a5c-ba57-166794b05c78"
     )
 )
 
 # Grab a specific dashboard from a specific workspace.
 pprint(
     dashboard_service.get_group_dashboard(
-        group_id='f78705a2-bead-4a5c-ba57-166794b05c78',
-        dashboard_id='1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358'
+        group_id="f78705a2-bead-4a5c-ba57-166794b05c78",
+        dashboard_id="1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358",
     )
 )
 
 # Grab all the tiles from a dashboard.
-pprint(
-    dashboard_service.get_tiles(
-        dashboard_id='1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358'
-    )
-)
+pprint(dashboard_service.get_tiles(dashboard_id="1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358"))
 
 # Grab all the tiles from a specific dashboard from a specific workspace.
 pprint(
     dashboard_service.get_group_tiles(
-        group_id='f78705a2-bead-4a5c-ba57-166794b05c78',
-        dashboard_id='1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358'
+        group_id="f78705a2-bead-4a5c-ba57-166794b05c78",
+        dashboard_id="1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358",
     )
 )
 
 # Grab a specific tile from a specific dashboard.
 pprint(
     dashboard_service.get_tile(
-        dashboard_id='1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358',
-        tile_id='093bfb85-828e-4705-bcf8-0126dd2d5d70'
+        dashboard_id="1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358",
+        tile_id="093bfb85-828e-4705-bcf8-0126dd2d5d70",
     )
 )
 
 # Grab a specific tile from a specific workspace and a specific workspace..
 pprint(
     dashboard_service.get_group_tile(
-        group_id='f78705a2-bead-4a5c-ba57-166794b05c78',
-        dashboard_id='1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358',
-        tile_id='093bfb85-828e-4705-bcf8-0126dd2d5d70'
+        group_id="f78705a2-bead-4a5c-ba57-166794b05c78",
+        dashboard_id="1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358",
+        tile_id="093bfb85-828e-4705-bcf8-0126dd2d5d70",
     )
 )
 
 # Clone a specific tile.
 pprint(
     dashboard_service.clone_tile(
-        dashboard_id='1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358',
-        tile_id='093bfb85-828e-4705-bcf8-0126dd2d5d70',
-        target_dashboard_id='86cb0a0e-612d-4822-9a29-d83478e21199'
+        dashboard_id="1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358",
+        tile_id="093bfb85-828e-4705-bcf8-0126dd2d5d70",
+        target_dashboard_id="86cb0a0e-612d-4822-9a29-d83478e21199",
     )
 )
 
 # Clone a specific tile from a specific workspace.
 pprint(
     dashboard_service.clone_group_tile(
-        group_id='f78705a2-bead-4a5c-ba57-166794b05c78',
-        dashboard_id='1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358',
-        tile_id='093bfb85-828e-4705-bcf8-0126dd2d5d70',
-        target_dashboard_id='86cb0a0e-612d-4822-9a29-d83478e21199'
+        group_id="f78705a2-bead-4a5c-ba57-166794b05c78",
+        dashboard_id="1a0a15d9-67d1-4e97-b7bd-4f0ed4ec8358",
+        tile_id="093bfb85-828e-4705-bcf8-0126dd2d5d70",
+        target_dashboard_id="86cb0a0e-612d-4822-9a29-d83478e21199",
     )
-)
+)

samples/use_dataflow_storage.py

@@ -1,3 +1,5 @@
+"""Demonstrates how to use the `DataflowStorageAccount` service."""
+
 from pprint import pprint
 from configparser import ConfigParser
 from powerbi.client import PowerBiClient
@@ -6,26 +8,24 @@
 config = ConfigParser()
 
 # Read the file.
-config.read('config/config.ini')
+config.read("config/config.ini")
 
 # Get the specified credentials.
-client_id = config.get('power_bi_api', 'client_id')
-redirect_uri = config.get('power_bi_api', 'redirect_uri')
-client_secret = config.get('power_bi_api', 'client_secret')
+client_id = config.get("power_bi_api", "client_id")
+redirect_uri = config.get("power_bi_api", "redirect_uri")
+client_secret = config.get("power_bi_api", "client_secret")
 
 # Initialize the Client.
 power_bi_client = PowerBiClient(
     client_id=client_id,
     client_secret=client_secret,
-    scope=['https://analysis.windows.net/powerbi/api/.default'],
+    scope=["https://analysis.windows.net/powerbi/api/.default"],
     redirect_uri=redirect_uri,
-    credentials='config/power_bi_state.jsonc'
+    credentials="config/power_bi_state.jsonc",
 )
 
 # Initialize the `DataflowStorageAccount` service.
 dataflow_storage_service = power_bi_client.dataflow_storage_account()
 
 # Refresh Users Permissions.
-pprint(
-    dataflow_storage_service.get_dataflow_storage_accounts()
-)
+pprint(dataflow_storage_service.get_dataflow_storage_accounts())