Skip to main content

Download unit outline PDFs from Curtin University's LITEC system

Project description

outline-dl

Download unit outline PDFs from Curtin University's LITEC system.

Installation

pip install outline-dl

After installing, you need to install the browser binary:

playwright install chromium

From source

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

Configuration

Credentials

Credentials are resolved in this order:

  1. CLI flags (-u / -p)
  2. Environment variables (UO_USERNAME / UO_PASSWORD)
  3. .env file (searched in order):
    • ~/.config/outline-dl/.env (recommended for global installs)
    • ~/.outline-dl.env
    • ./.env (current directory)
  4. Interactive prompt

To set up a .env file:

mkdir -p ~/.config/outline-dl
cat > ~/.config/outline-dl/.env <<EOF
UO_USERNAME=your_curtin_id
UO_PASSWORD=your_password
EOF
chmod 600 ~/.config/outline-dl/.env

Unit codes

Unit codes (e.g. COMP1000) can be provided via:

  1. CLI arguments: outline-dl COMP1000 ISAD1000
  2. File: outline-dl -f units.txt (one per line, comma or space-separated)
  3. Interactive prompt: enter a space or comma-separated list when prompted

Usage

Batch mode

When unit codes are provided on the CLI or via a file, the tool runs non-interactively — it automatically selects the latest version and the best matching availability.

# Download a single unit outline (defaults to Bentley Perth Campus)
outline-dl COMP1000

# Download multiple units
outline-dl COMP1000 ISAD1000 COMP2000

# From a file
outline-dl -f units.txt

# Specify a different campus
outline-dl -c "Singapore Campus" COMP1000

# Download for all campuses
outline-dl -c all COMP1000

# Custom output directory
outline-dl -o ~/Downloads COMP1000

Interactive mode

When no unit codes are given on the CLI or via a file, the tool enters interactive mode. You'll be prompted for unit codes, then for each unit you can interactively select which version and availability to download.

outline-dl

Skipping existing downloads

By default, PDFs that have already been downloaded are skipped. This makes it safe to re-run a batch after a crash — it will pick up where it left off.

To force re-download:

outline-dl --overwrite COMP1000

Other options

# Watch the browser (useful for debugging)
outline-dl --visible COMP1000

# Adjust timeout for slow connections (milliseconds)
outline-dl --timeout 60000 COMP1000

PDFs are saved to ./outlines/ by default.

Help

outline-dl --help

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

outline_dl-0.2.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

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

outline_dl-0.2.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file outline_dl-0.2.0.tar.gz.

File metadata

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

File hashes

Hashes for outline_dl-0.2.0.tar.gz
Algorithm Hash digest
SHA256 bb5d74a9de3ba8dfdc4a8e47df8bb79ddd006e9545bb51718eddb952ad42b778
MD5 6c0e34b20dbf0c718294f1b499e345d3
BLAKE2b-256 ab78b736a037a7cc3ebd6e6beafb794f09b4b789aa9950cfb3477a0dc25b2e51

See more details on using hashes here.

File details

Details for the file outline_dl-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: outline_dl-0.2.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 outline_dl-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80dfbf14918ea72ec59c00e1cd2d924b7483d793294fb6a52a17d6820f7c444b
MD5 a28082887b16aa14df736f0ba360c6e1
BLAKE2b-256 47ec9b76deff918f33478cd3acd9a58b958437c3caec375f01c6c492bb34d4c1

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