Skip to content

WeeklyClassScheduleBuilder is a Java-based command-line tool designed to generate and manage weekly class schedules by converting JSON files into ICS calendar files.

Notifications You must be signed in to change notification settings

lorenzo-cmyk/WeeklyClassScheduleBuilder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Weekly Class Schedule Builder (WCSB)

WCSB is a command-line tool designed to help you create and manage weekly class schedules. It allows you to generate example JSON files and convert these JSON files into ICS files to be imported in online calendars such as MS Outlook.

Requirements

  • Java 23

Usage

To use WCSB, you can use the following command-line options:

  • -h, --help: Displays help information.
  • -v, --version: Displays the current version of the program.
  • -e, --example: Generates an example JSON file. Must be used with -o (output).
  • -s, --startDay: Specifies the week start date. Must be a Monday formatted as YYYY-MM-DD.
  • -o, --output: Specifies the output file path for saving the generated result.
  • -i, --input: Specifies the input JSON file to be processed into a usable ICS file. Must be used with -s ( startDay) and -o (output).
  • -d, --directory: Specifies the input directory - containing multiple JSON files - to perform a batch conversion into usable ICS files. Must be used with -s (startDay) and -o (output). The output flag should specify an output directory. The destination folder will be created automatically.

Examples

  1. Display help information:

    java -jar WCSB.jar -h
  2. Display version information:

    java -jar WCSB.jar -v
  3. Generate an example JSON file:

    java -jar WCSB.jar -e -o /path/to/output/example.json
  4. Convert a JSON file to an ICS file:

    java -jar WCSB.jar -i /path/to/input/schedule.json -s 2023-10-02 -o /path/to/output/schedule.ics
  5. Convert multiple JSON files to ICS files:

    java -jar WCSB.jar -d /path/to/input/directory -s 2023-10-02 -o /path/to/output/directory

About

WeeklyClassScheduleBuilder is a Java-based command-line tool designed to generate and manage weekly class schedules by converting JSON files into ICS calendar files.

Topics

Resources

Stars

Watchers

Forks

Languages