Office365-REST-Python-Client 2.4.2__py3-none-any.whl → 2.4.4__py3-none-any.whl

{Office365_REST_Python_Client-2.4.2.dist-info → Office365_REST_Python_Client-2.4.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Office365-REST-Python-Client
-Version: 2.4.2
+Version: 2.4.4
 Summary: Microsoft 365 & Microsoft Graph Library for Python
 Home-page: https://github.com/vgrem/Office365-REST-Python-Client
 Author: Vadim Gremyachev
@@ -24,6 +24,7 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
@@ -40,7 +41,7 @@ Office 365 & Microsoft Graph library for Python
 1. [Installation](#Installation)
 2. [Working with SharePoint API](#Working-with-SharePoint-API) 
 3. [Working with Outlook API](#Working-with-Outlook-API) 
-4. [Working with OneDrive API](#Working-with-OneDrive-API)
+4. [Working with OneDrive and SharePoint API v2 APIs](#working-with-onedrive-and-sharepoint-v2-apis)
 5. [Working with Teams API](#Working-with-Microsoft-Teams-API)
 6. [Working with OneNote API](#Working-with-Microsoft-OneNote-API)
 7. [Working with Planner API](#Working-with-Microsoft-Planner-API)  
@@ -67,7 +68,7 @@ pip install Office365-REST-Python-Client
 >pip install git+https://github.com/vgrem/Office365-REST-Python-Client.git
 >```
 
-# Authentication Credentials
+# Authentication
 For the following examples, relevant credentials can be found in the Azure Portal.
 
 Steps to access:
@@ -78,44 +79,78 @@ Steps to access:
 5. In the application's "Overview" page, the client id can be found under "Application (client) id"
 6. In the application's "Certificates & Secrets" page, the client secret can be found under the "Value" of the "Client Secrets." If there is no client secret yet, create one here.
 
+
 # Working with SharePoint API
 
-The list of supported API versions: 
--   [SharePoint 2013 REST API](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) and above 
--   SharePoint Online & OneDrive for Business REST API
+   The `ClientContext` client provides the support for a legacy SharePoint REST and OneDrive for Business REST APIs, 
+   the list of supported versions: 
+   -   [SharePoint 2013 REST API](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) and above 
+   -   [SharePoint Online REST API](https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service)
+   -   OneDrive for Business REST API
 
-#### Authentication
+### Authentication
+
+   The following auth flows are supported:
 
-The following auth flows are supported:
+#### 1. Using a SharePoint App-Only principal (client credentials flow)
 
-- app principals flow: 
-  `ClientContext.with_credentials(client_credentials)`
+   This auth method is compatible with SharePoint on-premises and still relevant 
+   model in both SharePoint on-premises as SharePoint Online, 
+   the following methods are available: 
+
+   - `ClientContext.with_credentials(client_credentials)` 
+   - `ClientContext.with_client_credentials(client_id, client_secret)`
   
-  Usage:
-  ``` 
-  client_credentials = ClientCredential('{client_id}','{client_secret}')
-  ctx = ClientContext('{url}').with_credentials(client_credentials)
-  ```
-  Documentation: refer [Granting access using SharePoint App-Only](https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azureacs) for a details  
+   Usage:
+   ``` 
+   client_credentials = ClientCredential('{client_id}','{client_secret}')
+   ctx = ClientContext('{url}').with_credentials(client_credentials)
+   ```
   
-  Example: [connect_with_app_principal.py](examples/sharepoint/connect_with_app_only_principal.py)
+   Documentation:
+   - [Granting access using SharePoint App-Only](https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azureacs)  
+   - [wiki](https://github.com/vgrem/Office365-REST-Python-Client/wiki/How-to-connect-to-SharePoint-Online-and-and-SharePoint-2013-2016-2019-on-premises--with-app-principal)
   
-- user credentials flow: `ClientContext.with_credentials(user_credentials)`
+   Example: [connect_with_app_principal.py](examples/sharepoint/connect_with_app_only_principal.py)
+  
+#### 2. Using username and password 
 
-  Usage:
-  ``` 
-  user_credentials = UserCredential('{username}','{password}')
-  ctx = ClientContext('{url}').with_credentials(user_credentials)
-  ```
-  Example: [connect_with_user_credential.py](examples/sharepoint/connect_with_user_credential.py)
+   Usage:
+   ``` 
+   user_credentials = UserCredential('{username}','{password}')
+   ctx = ClientContext('{url}').with_credentials(user_credentials)
+   ```
+  
+   Example: [connect_with_user_credential.py](examples/sharepoint/connect_with_user_credential.py)
   
-- certificate credentials flow: `ClientContext.with_certificate(tenant, client_id, thumbprint, cert_path)`
+#### 3. Using an Azure AD application (certificate credentials flow) 
 
-  Documentation: [Granting access via Azure AD App-Only](https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread)  
+  Documentation: 
+   - [Granting access via Azure AD App-Only](https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread)  
+   - [wiki](https://github.com/vgrem/Office365-REST-Python-Client/wiki/How-to-connect-to-SharePoint-Online-with-certificate-credentials) 
   
   Example: [connect_with_client_certificate.py](examples/sharepoint/connect_with_client_certificate.py)
 
-#### Examples
+#### 4. Interactive
+
+   to login interactively i.e. via a local browser
+
+   Prerequisite: 
+   
+   > In Azure Portal, configure the Redirect URI of your
+   "Mobile and Desktop application" as ``http://localhost``.
+
+  Example: [connect_interactive.py](examples/sharepoint/connect_interactive.py)
+
+  Usage:
+```python
+from office365.sharepoint.client_context import ClientContext
+ctx = ClientContext(site_url).with_interactive(tenant_name_or_id, client_id)
+me = ctx.web.current_user.get().execute_query()
+print(me.login_name)
+```
+
+### Examples
  
 There are **two approaches** available to perform API queries:
 
@@ -161,7 +196,6 @@ web_title = json['d']['Title']
 print("Web title: {0}".format(web_title))
 ```
 
-
 The list of examples:
 
 - Working with files
@@ -191,7 +225,7 @@ the following clients are available:
 ~~- `OutlookClient` which targets Outlook API `v1.0` version (not recommended for usage since `v1.0` version is being deprecated.)~~
 
 
-#### Authentication
+### Authentication
 
 [The Microsoft Authentication Library (MSAL) for Python](https://pypi.org/project/msal/) which comes as a dependency 
 is used as a default library to obtain tokens to call Microsoft Graph API. 
@@ -281,7 +315,7 @@ Additional examples & scenarios:
 Refer to [examples section](examples/outlook) for other scenarios
 
 
-# Working with OneDrive API
+# Working with OneDrive and SharePoint v2 APIs
 
 #### Documentation 
 
@@ -359,7 +393,7 @@ Additional examples:
 -  [create list column](examples/onedrive/columns/create_text.py) 
 -  [download file](examples/onedrive/files/download_default.py)
 -  [export files](examples/onedrive/files/export.py)
--  [import files](examples/onedrive/files/import.py)   
+-  [upload folder](examples/onedrive/folder/upload.py)   
 -  [list drives](examples/onedrive/drives/list.py)
 -  [list files](examples/onedrive/list_files.py)