Canvas-Sync

Synchronize Canvas LMS courses and files to a local folder, preserving course structure and organization.

#Canvas   #Instructure   #LMS   #Synchronize   #Education

Table of Contents 📚

• Overview 📚
• Quick Start 🚀
• Installation 📦
• Usage ⚙️
• Security & Privacy 🔒
• Links 🔗

Overview 📚

Canvas-Sync mirrors your Canvas course structure locally so you can browse course materials offline. It downloads modules, assignments, pages, files, and optional external resources into a tidy folder layout.

Key Features include:

• Automatic synchronization of modules, assignments, and files
• Preserves course/module/subfolder structure locally
• Configurable: choose which content types to sync
• Optional download of external files referenced in descriptions
• Simple, user-friendly CLI with interactive setup (Typer + Rich)
• Rich progress bars and improved sync status output

Quick Start 🚀

Step 1 — Generate a Canvas API token

• Log in to your Canvas instance → Account → Settings → Approved Integrations → New Access Token.
• Copy the token and keep it secure. You will use it during setup.

Step 2 — Install Canvas-Sync

See the Installation section below for all options.

Step 3 — Launch and configure

Run canvas setup to launch the interactive setup:

1. Choose a local sync folder
2. Provide your Canvas domain (without https://, e.g. example.instructure.com)
3. Enter the API token from Step 1
4. Select the courses to sync

After setup, run canvas sync to begin downloading course content.

Installation 📦

Pick the method that best fits your workflow:

Using uv (recommended):

uv add canvas-sync-py
uv pip install canvas-sync-py

With pip:

pip install canvas-sync-py

From source (developer mode):

git clone https://github.com/Sang-Buster/Canvas-Sync.git
cd Canvas-Sync
pip install -e .
PYTHONPATH=src canvas --help

Usage ⚙️

Security & Privacy 🔒

Links 🔗

• Architecture notes: docs/ARCHITECTURE.md
• Releases and changelog: CHANGELOG.md