# Microsoft SharePoint Reader
```bash
pip install llama-index-readers-microsoft-sharepoint
```
The loader loads the files from a folder in sharepoint site.
It also supports traversing recursively through the sub-folders.
## Prequsites
### App Authentication using Microsoft Entra ID(formerly Azure AD)
1. You need to create an App Registration in Microsoft Entra ID. Refer [here](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application)
2. API Permissions for the created app.
1. Microsoft Graph --> Application Permissions --> Sites.ReadAll (**Grant Admin Consent**)
2. Microsoft Graph --> Application Permissions --> Files.ReadAll (**Grant Admin Consent**)
3. Microsoft Graph --> Application Permissions --> BrowserSiteLists.Read.All (**Grant Admin Consent**)
More info on Microsoft Graph APIs - [Refer here](https://learn.microsoft.com/en-us/graph/permissions-reference)
## Usage
To use this loader `client_id`, `client_secret` and `tenant_id` of the registered app in Microsoft Azure Portal is required.
This loader loads the files present in a specific folder in sharepoint.
If the files are present in the `Test` folder in SharePoint Site under `root` directory, then the input for the loader for `file_path` is `Test`
```python
from llama_index.readers.microsoft_sharepoint import SharePointReader
loader = SharePointLoader(
client_id="<Client ID of the app>",
client_secret="<Client Secret of the app>",
tenant_id="<Tenant ID of the Microsoft Azure Directory>",
)
documents = loader.load_data(
sharepoint_site_name="<Sharepoint Site Name>",
sharepoint_folder_path="<Folder Path>",
recursive=True,
)
```
The loader doesn't access other components of the `SharePoint Site`.
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-microsoft-sharepoint",
"maintainer": "arun-soliton",
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": "microsoft 365, microsoft365, sharepoint",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/a7/e3/3b30b3e8feca123ea689a3bb952d00f9b9bdb37d615690f60ca6202f6694/llama_index_readers_microsoft_sharepoint-0.2.2.tar.gz",
"platform": null,
"description": "# Microsoft SharePoint Reader\n\n```bash\npip install llama-index-readers-microsoft-sharepoint\n```\n\nThe loader loads the files from a folder in sharepoint site.\n\nIt also supports traversing recursively through the sub-folders.\n\n## Prequsites\n\n### App Authentication using Microsoft Entra ID(formerly Azure AD)\n\n1. You need to create an App Registration in Microsoft Entra ID. Refer [here](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application)\n2. API Permissions for the created app.\n 1. Microsoft Graph --> Application Permissions --> Sites.ReadAll (**Grant Admin Consent**)\n 2. Microsoft Graph --> Application Permissions --> Files.ReadAll (**Grant Admin Consent**)\n 3. Microsoft Graph --> Application Permissions --> BrowserSiteLists.Read.All (**Grant Admin Consent**)\n\nMore info on Microsoft Graph APIs - [Refer here](https://learn.microsoft.com/en-us/graph/permissions-reference)\n\n## Usage\n\nTo use this loader `client_id`, `client_secret` and `tenant_id` of the registered app in Microsoft Azure Portal is required.\n\nThis loader loads the files present in a specific folder in sharepoint.\n\nIf the files are present in the `Test` folder in SharePoint Site under `root` directory, then the input for the loader for `file_path` is `Test`\n\n\n\n```python\nfrom llama_index.readers.microsoft_sharepoint import SharePointReader\n\nloader = SharePointLoader(\n client_id=\"<Client ID of the app>\",\n client_secret=\"<Client Secret of the app>\",\n tenant_id=\"<Tenant ID of the Microsoft Azure Directory>\",\n)\n\ndocuments = loader.load_data(\n sharepoint_site_name=\"<Sharepoint Site Name>\",\n sharepoint_folder_path=\"<Folder Path>\",\n recursive=True,\n)\n```\n\nThe loader doesn't access other components of the `SharePoint Site`.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers microsoft_sharepoint integration",
"version": "0.2.2",
"project_urls": null,
"split_keywords": [
"microsoft 365",
" microsoft365",
" sharepoint"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "945e13622db1ebc2191d5046c0e025f957f0866c6935918ccfdc0abd27e29e6e",
"md5": "44ba8fac997e1cba86f9190f6712dfdd",
"sha256": "e5e6c3d83bf1be69e739c4f2162ca5373481d65ccd8114f004cc8951b8fffe34"
},
"downloads": -1,
"filename": "llama_index_readers_microsoft_sharepoint-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "44ba8fac997e1cba86f9190f6712dfdd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 45937,
"upload_time": "2024-04-30T21:16:03",
"upload_time_iso_8601": "2024-04-30T21:16:03.523937Z",
"url": "https://files.pythonhosted.org/packages/94/5e/13622db1ebc2191d5046c0e025f957f0866c6935918ccfdc0abd27e29e6e/llama_index_readers_microsoft_sharepoint-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a7e33b30b3e8feca123ea689a3bb952d00f9b9bdb37d615690f60ca6202f6694",
"md5": "33bc0f0c779caa89efab574a314466c8",
"sha256": "3f5c8a7ab681c6b96daf10242bffc82defe14ca66e392f77a81eb3fcac936729"
},
"downloads": -1,
"filename": "llama_index_readers_microsoft_sharepoint-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "33bc0f0c779caa89efab574a314466c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 47248,
"upload_time": "2024-04-30T21:16:05",
"upload_time_iso_8601": "2024-04-30T21:16:05.235690Z",
"url": "https://files.pythonhosted.org/packages/a7/e3/3b30b3e8feca123ea689a3bb952d00f9b9bdb37d615690f60ca6202f6694/llama_index_readers_microsoft_sharepoint-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 21:16:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-microsoft-sharepoint"
}
JSON