SharePoint API: Tenant, ContentType new methods & properties, unit tests & examples minor refactorings

Author: vvgrem@gmail.com

README-dev.md

@@ -10,11 +10,12 @@ $ pip install -r requirements-dev.txt
 
 # Running tests
 
-Most of the tests are end-to-end - connecting to real sites (not mocked). So one has to configure his/her office/sharepoint credentials. To do so, create a file ```.env``` like this (replace the bracketed values by your values):
+Most of the tests are end-to-end - operations are invoked against actual tenant (not mocked). 
+So one has to configure his/her office/sharepoint credentials. 
+To do so, create a file ```.env``` like this (replace the bracketed values by your values):
 
 ```
-export Office365_Python_Sdk_SecureVars='{username};{password};{client_id};{client_password}'
-export COMPANY={your_company}
+export office365_python_sdk_securevars='{username};{password};{client_id};{client_password}'
 ```
 
 This file is in .gitignore, so it will never be committed.
@@ -24,5 +25,13 @@ $ . .env   # source it to export the variable
 $ nose2 ...  # run the test(s) you need...
 ```
 
-# Configure Tenant
+#### Configure Tenant
 
+Roles:
+
+- Global reader
+- Groups admin
+- Search admin
+- SharePoint admin
+- Teams service admin
+- Users admin

examples/directory/clear_directory.py

@@ -21,8 +21,10 @@ def get_token_for_user():
 # deleted_users = client.directory.deletedUsers.get().execute_query()
 groups_count = len(deleted_groups)
 
-for index, deleted_grp in enumerate(deleted_groups):
-    print("({0} of {1}) Deleting {2} group ...".format(index + 1, groups_count, deleted_grp.properties['displayName']))
-    deleted_grp.delete_object()
-    client.execute_query()
+index = 0
+while len(deleted_groups) > 0:
+    cur_grp = deleted_groups[0]
+    print("({0} of {1}) Deleting {2} group ...".format(index + 1, groups_count, cur_grp.properties['displayName']))
+    cur_grp.delete_object().execute_query()
     print("Group deleted.")
+    index += 1

examples/onedrive/export_files.py

@@ -43,7 +43,8 @@ def download_files(remote_folder, local_path):
 client = GraphClient(get_token)
 
 # load drive properties
-drive = client.users["jdoe@mediadev8.onmicrosoft.com"].drive
+target_user_name = settings.get('test_accounts')[1]
+drive = client.users[target_user_name].drive
 # download files from OneDrive
 with tempfile.TemporaryDirectory() as path:
     download_files(drive.root, path)

examples/onedrive/import_files.py

@@ -37,6 +37,7 @@ def upload_files(remote_drive, local_root_path):
 
 # get target drive
 client = GraphClient(get_token)
-target_drive = client.users["jdoe@mediadev8.onmicrosoft.com"].drive
+user_name = settings.get('test_accounts')[1]
+target_drive = client.users[user_name].drive
 # import local files into OneDrive
 upload_files(target_drive, "../data")

examples/onedrive/upload_file.py

@@ -21,7 +21,8 @@ def acquire_token():
 
 
 client = GraphClient(acquire_token)
-target_drive = client.users["jdoe@mediadev8.onmicrosoft.com"].drive
+user_name = settings.get('test_accounts')[1]
+target_drive = client.users[user_name].drive
 
 local_path = "../../tests/data/SharePoint User Guide.docx"
 with open(local_path, 'rb') as f:

examples/outlook/send_message.py

@@ -26,14 +26,14 @@ def get_token():
         "ToRecipients": [
             {
                 "EmailAddress": {
-                    "Address": "vgrem@mediadev8.onmicrosoft.com"
+                    "Address": settings.get('test_accounts')[1]
                 }
             }
         ]
     },
     "SaveToSentItems": "false"
 }
 
-login_name = "mdoe@mediadev8.onmicrosoft.com"
-client.users[login_name].send_mail(message_json)
+user_name = settings.get('test_accounts')[0]
+client.users[user_name].send_mail(message_json)
 client.execute_query()

examples/sharepoint/connect_with_azure_app.py

@@ -1,9 +1,10 @@
 import os
 
 from office365.sharepoint.client_context import ClientContext
+from settings import settings
 
 app_settings = {
-    'url': 'https://mediadev8.sharepoint.com/sites/team',
+    'url': settings.get('team_site_url'),
     'client_id': '51d03106-4726-442c-86db-70b32fa7547f',
     'thumbprint': "6B36FBFC86FB1C019EB6496494B9195E6D179DDB",
     'certificate_path': '{0}/selfsigncert.pem'.format(os.path.dirname(__file__))

examples/sharepoint/lists_and_items/data_generator.py

@@ -76,7 +76,7 @@ def generate_contacts(context):
 
 
 if __name__ == '__main__':
-    ctx = ClientContext.connect_with_credentials("https://mediadev8.sharepoint.com/sites/team",
+    ctx = ClientContext(settings.get('team_site_url')).with_credentials(
                                                  UserCredential(settings['user_credentials']['username'],
                                                                 settings['user_credentials']['password']))
     # generate_contacts(ctx)

examples/sharepoint/export/exportList.py renamed to examples/sharepoint/lists_and_items/export_list_items_csv.py

@@ -7,17 +7,15 @@
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.sharepoint.client_context import ClientContext
 
-"Demonstrates how to export a List data"
+"Demonstrates how to export a List data as csv"
 
-ctx = ClientContext.connect_with_credentials("https://mediadev8.sharepoint.com/sites/team",
+ctx = ClientContext(settings.get('team_site_url')).with_credentials(
                                              ClientCredential(settings['client_credentials']['client_id'],
                                                               settings['client_credentials']['client_secret']))
 # 1.retrieve list data
 list_title = "Contacts_Large"
 list_to_export = ctx.web.lists.get_by_title(list_title)
-list_items = list_to_export.items.top(100)
-ctx.load(list_items)
-ctx.execute_query()
+list_items = list_to_export.items.top(100).get().execute_query()
 if len(list_items) == 0:
     print("No data found")
 

examples/sharepoint/lists_and_items/read_large_list.py

@@ -48,7 +48,7 @@ def get_items(target_list):
     print("Item at index: {0}".format(items[index].properties))
 
 
-ctx = ClientContext.connect_with_credentials("https://mediadev8.sharepoint.com/sites/team",
+ctx = ClientContext(settings.get('team_site_url')).with_credentials(
                                              ClientCredential(settings['client_credentials']['client_id'],
                                                               settings['client_credentials']['client_secret']))