ucas-iclass 0.1.1

iClass API for UCAS
Documentation

ucas-iclass

GitHub License GitHub Workflow Status GitHub Release GitHub Downloads (all assets, all releases) Crates.io Version Crates.io Total Downloads docs.rs

[!WARNING] This repository is for learning purposes only. Use at your own risk.

iClass API for UCAS. Should also work for other schools, but not guaranteed.

📥 Installation

Using binstall

cargo binstall ucas-iclass

Downloading from Releases

Navigate to the Releases page and download respective binary for your platform. Make sure to give it execute permissions.

Compiling from Source

cargo install ucas-iclass

📖 Usage

  • 🔑 Login: Login to iClass and save session to a file.

    ucas-iclass login <username> <password> [-s <session-file>]
    
  • 📖 Courses: List courses in current semester.

    ucas-iclass courses [-s <session-file>]
    
  • 📃 Schedule: Get schedule for a specific date or week, defaulting to today.

    ucas-iclass schedule [-d <date>] [-w] [-s <session-file>]
    
  • ✅ Checkin: Check-in for a specific schedule by id or uuid, defaulting to current schedule if any.

    ucas-iclass checkin [<id_or_uuid>] [-s <session-file>]
    

☑️ TODO

  • Customize api root for cli.
  • Checkin: Default to current schedule if no id_or_uuid provided.

🎉 Credits