Skip to main content

Download Blackboard course exports from Curtin University's LMS

Project description

course-dl

Download Blackboard course exports from Curtin University's LMS as Common Cartridge packages, useful for migrating courses to Canvas or other LMS platforms.

Installation

uv tool install course-dl
playwright install chromium

Or install from source:

git clone https://github.com/michael-borck/course-dl.git
cd course-dl
uv sync
uv run playwright install chromium

Usage

Exporting is a two-step process because Blackboard takes 15–30 minutes to build each Common Cartridge package.

Step 1: Trigger builds

# Trigger builds for specific courses (fuzzy-matched)
course-dl build COMP1000 "Data Structures"

# Trigger builds for all courses
course-dl build --all

# Interactive picker — no args, select from a list
course-dl build

Blackboard queues the export and confirms with "This action has been queued." You can trigger builds for many courses at once — they build in parallel on the server.

Step 2: Download packages

Wait 15–30 minutes, then download with the same search terms:

# Download matching courses
course-dl download COMP1000 "Data Structures"

# Download all
course-dl download --all

# Interactive picker
course-dl download

Courses with no package ready yet will show "not ready" — just run the command again later.

Typical batch workflow

# 1. Trigger all builds
course-dl build --all

# 2. Wait 15-30 minutes...

# 3. Download everything
course-dl download --all -o exports/

Common options

course-dl [OPTIONS] {build,download}

Options (before subcommand):
  -u, --username STR    Curtin username
  -p, --password STR    Curtin password
  --visible             Show the browser window (default: headless)
  --timeout INT         Navigation timeout in ms (default: 60000)

Subcommand options:
  SEARCH...             Search terms (fuzzy-matched against course titles)
  -f, --file PATH       File with search terms (one per line)
  --all                 Select all courses
  --match-threshold INT Fuzzy match score 0-100 (default: 60)

Download-only options:
  -o, --output-dir PATH Output directory (default: ./exports/)
  --overwrite           Re-download courses that already exist locally

Fuzzy matching

Course titles in Blackboard are long. You don't need the full title:

course-dl build COMP1000              # matches by unit code
course-dl build "Unix and C"          # matches by partial name
course-dl build "Data Structures"     # matches by topic

Interactive picker

When no search terms are provided, an interactive checkbox list is shown. Use arrow keys to move, space to toggle, enter to confirm.

Skip behaviour

course-dl download skips courses that already have a .zip or .imscc file in the output directory matching the unit code. Use --overwrite to force re-download.

When only one package exists on Blackboard, it is deleted after download (since we created it). When multiple packages exist, none are deleted and the tool logs which one was downloaded.

Credentials

Credentials are resolved in order:

  1. CLI flags (-u, -p)
  2. Environment variables (CDL_USERNAME, CDL_PASSWORD)
  3. .env file (searched in order):
    • ~/.config/course-dl/.env
    • ~/.course-dl.env
    • ./.env
  4. Interactive prompt

Copy .env.example to one of the above locations:

cp .env.example ~/.config/course-dl/.env

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

course_dl-0.3.0.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

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

course_dl-0.3.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file course_dl-0.3.0.tar.gz.

File metadata

  • Download URL: course_dl-0.3.0.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for course_dl-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fb5f3f39d87246dfd96e5d55faf3cd5661346575196e388266d7d82f72912595
MD5 fda0fb1d30370d04af2f142da5adccea
BLAKE2b-256 b97f622b9fc54794d0ac411d56cdfb11d8eb2ffde215fd249687d95b12c1cc1c

See more details on using hashes here.

File details

Details for the file course_dl-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: course_dl-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for course_dl-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c6403c36c4f2b2e95964e4016df8fb98f62dc7c8b04c464ac8a6be8a24065677
MD5 ecd9218dc0065d09e8aa7643e37af0c3
BLAKE2b-256 60c598b8022371658229993d3a6f0e74a54d65f1d90e6af09c708f9c8a3a2802

See more details on using hashes here.

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