Skip to main content

A shared package for reading and writing to SharePoint

Project description

MPR-sharepoint-utils

Tools for interfacing between python code and SharePoint storage.

  • built directly off graphql api
  • currently requires pandas (eventually could have a base SharepointUtils class that only returns file streams, does not do pd.read_csv or pd.read_excel)

Installing the package

pipenv install mpr-sharepoint-utils

Once the package is installed, you can use it like this:

from sharepoint_utils.lib import SharePointUtils

Using the package:

  • Useful methods are in the SharePointUtils class, which requires these arguments to connect to your SharePoint instance:
    • client_id, the ID portion of your user (or service) account credentials
    • client_secret, the secret string of your user (or service) credentials
    • site_id, the ID of the SharePoint site you wish to access
    • tenant, the name of your organization (you can find this in a SharePoint URL, like "tenant.sharepoint.com")

FAQs

Q: How do I know what my site ID is? A: First, get your access token with the first command below; then, plug that into the second command below to get your site ID.

Get access token (can use to get site id given hostname and path (site/subsite)):

curl --location --request POST 'https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=INSERT_CLIENT_ID' \
--data-urlencode 'scope=https://graph.microsoft.com/.default' \
--data-urlencode 'client_secret=INSERT_CLIENT_SECRET' \
--data-urlencode 'grant_type=INSERT_CLIENT_CREDENTIALS'

Get site ID

curl --location --request GET 'https://graph.microsoft.com/v1.0/sites/{hostname}:/sites/{path}?$select=id' \
--header 'Authorization: Bearer access_token' \
--data

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mpr_sharepoint_utils-1.0.2.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

mpr_sharepoint_utils-1.0.2-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file mpr_sharepoint_utils-1.0.2.tar.gz.

File metadata

  • Download URL: mpr_sharepoint_utils-1.0.2.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for mpr_sharepoint_utils-1.0.2.tar.gz
Algorithm Hash digest
SHA256 e880fdf5f7de8cbbd9af4a611ceed017c96265d83e88b08a843e3a8bc460cb30
MD5 8cc47a227cab719ed56889a2e8bb5b9f
BLAKE2b-256 b85669afa701abe07284734c61eeda365dc707ee7335a3f29e1ca3bfb718de7a

See more details on using hashes here.

File details

Details for the file mpr_sharepoint_utils-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mpr_sharepoint_utils-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4691f8629b9779d5397f170803879a626df29d02074ff4460eb3f4f6895c0ff2
MD5 851ef60a730ca4b8e868edbf0d90fe22
BLAKE2b-256 e1c019c21e87516ff61e37fe07b542f27a2545c8f569590b05d698ad0abbcf5d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page