SharePoint API: example to download files from lib

Author: vgrem

examples/auth/with_adal.py

@@ -10,7 +10,7 @@
 
 
 def acquire_token():
-    import adal # pylint: disable=E0401
+    import adal  # pylint: disable=E0401
 
     settings = load_settings()
     authority_url = "https://login.microsoftonline.com/{0}".format(

examples/onedrive/folders/list_with_files.py

@@ -1,6 +1,4 @@
-"""
-
-"""
+""" """
 
 from office365.graph_client import GraphClient
 from office365.onedrive.driveitems.driveItem import DriveItem

examples/outlook/messages/create_draft_with_attachments.py

@@ -1,6 +1,4 @@
-"""
-
-"""
+""" """
 
 import base64
 

examples/sharepoint/files/download_by_shared_link.py

@@ -1,6 +1,4 @@
-"""
-
-"""
+""" """
 
 import os
 import tempfile

examples/sharepoint/files/download_from_lib.py

@@ -0,0 +1,33 @@
+"""
+Demonstrates how to download a files from SharePoint library
+"""
+
+import tempfile
+from pathlib import Path
+
+from office365.sharepoint.client_context import ClientContext
+from tests import test_client_credentials, test_team_site_url
+
+ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
+
+doc_lib = ctx.web.lists.get_by_title("Documents")
+items = (
+    doc_lib.items.select(["FileSystemObjectType"])
+    .select(["Id", "FileRef", "FileDirRef", "FileLeafRef"])
+    .filter("FSObjType eq 0")
+    .get_all()
+    .execute_query()
+)
+
+download_root_path = Path(tempfile.mkdtemp())
+
+for item in items:
+
+    download_path = download_root_path / item.properties.get("FileDirRef").lstrip("/")
+    download_path.mkdir(parents=True, exist_ok=True)
+
+    download_file_path = download_path / item.properties.get("FileLeafRef")
+
+    with open(download_file_path, "wb") as f:
+        item.file.download(f).execute_query()
+        print(f"File has been downloaded into {f.name}")

examples/sharepoint/folders/folder_exists.py

@@ -1,5 +1,5 @@
 """
- How to determine whether folder exist?
+How to determine whether folder exist?
 """
 
 from office365.sharepoint.client_context import ClientContext

examples/sharepoint/folders/folder_exists_v2.py

@@ -1,5 +1,5 @@
 """
- How to determine whether folder exist?
+How to determine whether folder exist?
 """
 
 from office365.runtime.client_request_exception import ClientRequestException

examples/sharepoint/listitems/update.py

@@ -1,6 +1,4 @@
-"""
-
-"""
+""" """
 
 import sys
 from random import randint

examples/sharepoint/lists/import_lib.py

@@ -1,6 +1,4 @@
-"""
-
-"""
+""" """
 
 from random import randrange
 

examples/sharepoint/run_test_rate_limit.py

@@ -1,5 +1,4 @@
-"""
-"""
+""" """
 
 import asyncio