Skip to main content

Download videos and files from SharePoint — like yt-dlp for SharePoint

Project description

sharepoint-dl

sharepoint-dl logo

Download videos and files from SharePoint — like yt-dlp for SharePoint.

CI Coverage PyPI Python License: MIT


Why?

  • Microsoft Stream (Classic) was retired — all videos now live in SharePoint / OneDrive
  • Browser downloads fail for large files, offer no resume, and require clicking through menus
  • Enterprise tenants often block direct downloadssp-dl handles this automatically via adaptive streaming
  • yt-dlp doesn't support SharePoint authentication
  • sp-dl gives you one command to download any file from SharePoint

What It Downloads

Content Source
Videos (.mp4, .mov, .webm) SharePoint document libraries, Stream on SharePoint
Meeting recordings OneDrive / SharePoint auto-saved recordings
Download-blocked videos Enterprise tenants with admin download restrictions
Any file SharePoint document libraries
Shared links Anonymous or org-internal sharing links

Install

pip install sharepoint-dl

Or with pipx for isolated install:

pipx install sharepoint-dl

Quick Start

First time? Run sp-dl quickstart for a step-by-step guide.

Using Cookies (Recommended — Easiest)

  1. Log into SharePoint in your browser
  2. Export cookies to a file using a browser extension like "Get cookies.txt LOCALLY"
  3. Download:
sp-dl download "https://contoso.sharepoint.com/sites/Team/_layouts/15/stream.aspx?id=/sites/Team/Shared%20Documents/demo.mp4" \
  --cookies cookies.txt

Using Device Code (OAuth — for enterprise tenants)

# One-time login (you'll be prompted for your org tenant)
sp-dl auth login --tenant contoso

# Download (uses saved token)
sp-dl download "https://contoso.sharepoint.com/sites/Team/Shared%20Documents/video.mp4"

Download-Blocked Videos (Enterprise Tenants)

Some organizations disable direct file downloads via SharePoint admin policy. sp-dl detects this automatically and switches to parallel adaptive streaming:

# Works even when admin has blocked downloads!
# sp-dl detects the block → prompts OAuth2 login → streams via DASH manifest
sp-dl download "https://contoso-my.sharepoint.com/personal/user/_layouts/15/stream.aspx?id=..." \
  --cookies cookies.txt

How it works:

  1. Detects download-blocked policy from the stream page or 401/403 response
  2. Acquires an OAuth2 token via device code flow (cached per-domain for future use)
  3. Builds a DASH manifest URL via Microsoft's media proxy
  4. Downloads all video/audio segments in parallel (10 concurrent connections)
  5. Muxes audio + video into a single MP4 using ffmpeg

Requires ffmpeg for final muxing: brew install ffmpeg (macOS) or apt install ffmpeg (Linux)

Usage

# Download a video
sp-dl download <URL> --cookies cookies.txt

# Download from a sharing link
sp-dl download "https://contoso.sharepoint.com/:v:/s/Team/EaBcDeFgHiJk" -c cookies.txt

# Show file info without downloading
sp-dl download <URL> --info -c cookies.txt

# JSON metadata
sp-dl download <URL> --json -c cookies.txt

# Custom output path
sp-dl download <URL> -o ~/Videos/meeting.mp4 -c cookies.txt

# Output template
sp-dl download <URL> -o "%(site)s/%(folder)s/%(filename)s" -c cookies.txt

# Limit speed
sp-dl download <URL> --limit-rate 5M -c cookies.txt

# Skip existing files
sp-dl download <URL> --no-overwrites -c cookies.txt

# Batch download (one URL per line)
sp-dl batch urls.txt -c cookies.txt

# Quick start guide
sp-dl quickstart

Supported URL Patterns

Pattern Example
Stream player https://tenant.sharepoint.com/sites/Team/_layouts/15/stream.aspx?id=...
Sharing link https://tenant.sharepoint.com/:v:/s/Team/EncodedToken
Direct path https://tenant.sharepoint.com/sites/Team/Shared%20Documents/file.mp4
OneDrive https://tenant-my.sharepoint.com/personal/user/Documents/file.mp4
Doc.aspx https://tenant.sharepoint.com/sites/Team/_layouts/15/Doc.aspx?sourcedoc={guid}

Authentication Methods

Method Best For Setup
--cookies Quick downloads, read-only users Export cookies from browser (e.g. "Get cookies.txt LOCALLY" extension)
sp-dl auth login Enterprise tenants, download-blocked sites One-time device code login
--client-id --client-secret Service accounts, CI/CD Azure AD admin setup

Enterprise users: When direct downloads are blocked by admin policy, sp-dl automatically falls back to OAuth2 + adaptive streaming. Your first download will prompt for a device code login, and the token is cached for subsequent downloads.

Auth Management

sp-dl auth login --tenant contoso       # Device code login (prompted for tenant)
sp-dl auth login --tenant contoso -i    # Browser-based login
sp-dl auth status                        # Check auth state
sp-dl auth logout                        # Clear tokens

Tip: You can pass a SharePoint URL as the tenant and it will be auto-detected: sp-dl auth login --tenant https://contoso.sharepoint.com

Output Templates

Field Description Example
%(filename)s Original filename training.mp4
%(title)s Name without extension training
%(ext)s Extension mp4
%(site)s SharePoint site Team
%(folder)s Parent folder Recordings
%(date)s Modified date 20260415
%(author)s Created by John Smith

Configuration

Create ~/.config/sp-dl/config.toml:

[defaults]
output_template = "%(filename)s"
cookies_file = "/path/to/cookies.txt"
retries = 5
no_overwrites = false

[auth]
tenant = "contoso.onmicrosoft.com"

Environment variables: SP_DL_COOKIES, SP_DL_TENANT, SP_DL_CLIENT_ID, SP_DL_OUTPUT

Development

git clone https://github.com/bhayanak/sp-dl.git
cd sp-dl
pip install -e ".[dev]"

# Run tests with coverage
pytest --cov=sp_dl -v

# Lint & format
ruff check src/ tests/
ruff format src/ tests/

License

MIT

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

sharepoint_dl-1.1.0.tar.gz (66.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sharepoint_dl-1.1.0-py3-none-any.whl (58.9 kB view details)

Uploaded Python 3

File details

Details for the file sharepoint_dl-1.1.0.tar.gz.

File metadata

  • Download URL: sharepoint_dl-1.1.0.tar.gz
  • Upload date:
  • Size: 66.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sharepoint_dl-1.1.0.tar.gz
Algorithm Hash digest
SHA256 8b62099e8d4ce5231fe308d8047cb229502b2b1c933fc14c85c7180a94e5d294
MD5 2b97550e003b528c6629684cc5b2e6c9
BLAKE2b-256 3a9b2134891ca470dbaa4e46f5ddb3265aaa67471c87fab2424dbdc27fa831d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for sharepoint_dl-1.1.0.tar.gz:

Publisher: release.yml on bhayanak/sp-dl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sharepoint_dl-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: sharepoint_dl-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 58.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sharepoint_dl-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24d6f720f8a38a239b6c48ce3726d26ef2fefaa640ec1694c887f65895fe3a29
MD5 844da54c7dc17572251e1288788823ec
BLAKE2b-256 5ff4f4d4e1806c074f619c239e01dd5b9ea3a912b791b36215946768da709a74

See more details on using hashes here.

Provenance

The following attestation bundles were made for sharepoint_dl-1.1.0-py3-none-any.whl:

Publisher: release.yml on bhayanak/sp-dl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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