SharePlum

What it is and what it does

SharePlum wraps the SharePoint web services API to let you read and write list data, manage folders and files, and authenticate to both on-premises and Office365 SharePoint sites without writing raw HTTP requests. It abstracts away XML parsing and SOAP details, presenting SharePoint lists as Python dictionaries and automating type conversion between SharePoint's internal representation and Python types.

The library supports NTLM authentication for on-premises deployments and cookie-based authentication for Office365. It can query lists with filters, upload and download files, and perform check-in/check-out operations on documents. However, the project has been archived since early 2023 with no active maintenance, so it is best suited for teams maintaining legacy SharePoint integrations rather than new projects.

Use it for:

• Retrieve and update SharePoint list items from Python scripts without manual SOAP or REST calls.
• Automate file uploads and downloads to SharePoint document libraries using folder operations.
• Migrate data from on-premises or Office365 SharePoint to other systems via Python ETL scripts.
• Query and filter SharePoint lists by column values to extract specific records for reporting.
• Perform bulk check-in and check-out operations on SharePoint documents programmatically.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

SharePlum provides a Python interface to SharePoint services, handling authentication and list/folder operations so you can work with SharePoint data using standard Python objects and methods.

No for new projects. SharePoint integration is better served by Microsoft's official SDKs or actively maintained alternatives. Install only if you are maintaining legacy code that already depends on SharePlum and cannot migrate, or if you are locked into an older SharePoint version with no other option. The abandoned status and lack of maintenance since 2023 create long-term risk.

Install

shareplum on PyPI

pip install shareplum

uv add shareplum

poetry add shareplum

Installing SharePlum

Before you install

Low install friction with four runtime dependencies (lxml, requests, requests-ntlm, requests-toolbelt). However, the project is archived and abandoned as of 2023-02-08, with no maintenance for over 2 years; use only if you are locked into legacy SharePoint versions or cannot migrate.

License in practice

MIT license is permissive and imposes no restrictions on use, modification, or distribution in your own projects.

Quickstart

from shareplum import Site
from requests_ntlm import HttpNtlmAuth

auth = HttpNtlmAuth('DIR\\username', 'password')
site = Site('https://abc.com/sites/MySharePointSite/', auth=auth)
sp_list = site.List('list name')
data = sp_list.GetListItems('All Items', rowlimit=200)

Requires valid SharePoint site URL and appropriate authentication credentials (NTLM or Office365); network access to the SharePoint server is mandatory.

Verify before relying

• Whether the package works reliably with modern SharePoint Online or only legacy on-premises versions.
• Compatibility with Python versions beyond 3.8, given the classifiers only list up to 3.8.
• Whether requests-ntlm and requests-toolbelt remain actively maintained and secure.

Package facts

Evidence: SharePlum-0.5.1-py2.py3-none-any.whl

Keywords: SharePoint

Tags

More WWW/HTTP packages