canvas-sync-py 0.1.0

Synchronize modules, assignments and files from Canvas by Instructure to your local computer

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
• Key Features
• Quick Start
• Installation
• Usage
• Configuration
• Security & Privacy
• Development
• Links
• Changelog

---

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 ⭐

• 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)

Quick Start 🚀

Follow these steps to get up and running quickly.

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.

   

2. Install Canvas-Sync (pick one)

   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
   

3. Launch and configure

   • Run canvas to launch the interactive setup. Choose choose a local sync folder, provide your Canvas domain, the API token from step 1, and select courses to be synced.
   • After setup, run canvas sync to begin downloading course content.

4. Usage, Configuration, and Common Flags

   • canvas --help — Launch CLI and show help message
   • canvas setup — Re-run setup and update saved values
   • canvas info — Show current saved settings
   • canvas sync — Start synchronization using saved settings
   • canvas reset — Reset and remove saved encrypted settings (use when you forgot your password)

   Configuration notes:

   • Settings are stored encrypted locally. Use canvas --setup to change them or canvas reset to remove them.

Security & Privacy 🔒

• Your Canvas API token is encrypted locally using AES and a password-derived key.
• Canvas-Sync is read-only: it only downloads course content and does not modify Canvas.
• Do not share your token; if compromised, revoke it in Canvas and run canvas reset.

Links 🔗

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