diff --git a/README.md b/README.md index 3d5d952a450638041ae7e95e3c1df1f5982d0091..39aedd3a2436090a115fb14e28335627cbe5fef2 100644 --- a/README.md +++ b/README.md @@ -15,30 +15,28 @@ This project tries to make CELCAT usable by: Usage: fetch-celcat [OPTIONS] COURSE_REQUEST_FILE CREDENTIALS_FILE Options: - --json, --json-raw TEXT If set, raw CELCAT events are written as JSON to this file. - --csv-raw TEXT If set, raw (unfiltered) events are written as CSV to this file. - --csv TEXT If set, filteret events are written as CSV to this file. - --ics TEXT If set, filtered events are written as ICS to this file. - --csv-no-description If set, CSV outputs will not contain the description column. - --help Show this message and exit. + --json TEXT If set, raw events fetched from CELCAT as JSON are written to this file. + --csv TEXT If set, fetched events are written as CSV to this file. + --ics TEXT If set, fetched events are written as ICS to this file. + --help Show this message and exit. ``` **The course request input file** defines which courses you are interested in. For example, if you give the following courses: - BAS (apogee code KINXIB11) - - 5 TD with group INXIB11A4 from 2022-09-05 to 2022-10-22 - - 3 TP with group INXIB11A42 from 2022-09-05 to 2022-10-22 -- SR1 (apogee code KINXIB21) - - 5 TP with group INXIB21A42 from from 2022-09-05 to 2022-10-22 + - 3 TP with group INXIB11A21 for weeks 39 40 41 of academic year 2024, Tuesday at 18h + - 3 TP with group INXIB11B31 for weeks 39 40 41 of academic year 2024, Wednesday at 10h +- SR2 (apogee code KINXIB31) + - 3 CTD with group INXIB31B2 for weekds 42 43 48 of academic year 2024, Tuesday at 07h45 an equivalent CSV file would be the following: -``` -module_apogee,module_readable,begin_date,end_date,course_type,group,expected_nb_slots -KINXIB11,BAS,2022-09-05 00:00:00,2022-10-21 23:59:00,TD,INXIB11A4,5 -KINXIB11,BAS,2022-09-05 00:00:00,2022-10-21 23:59:00,TP,INXIB11A42,3 -KINXIB21,SR1,2022-09-05 00:00:00,2022-10-21 23:59:00,TP,INXIB21A42,5 +```csv +mod_code,display_name,student_group,slots,duration,academic_year,weeks +KINXIB11,BAS TP,INXIB11A21,Ma18h,2h,2024-2025,39-41 +KINXIB11,BAS TP,INXIB11B31,Me10h,2h,2024-2025,39-41 +KINXIB31,SR2 CTD,INXIB31B2,Ma07h45,2h,2024-2025,42 43 48 ``` **The credentials input file** is a JSON file that contains your UT3 credential information, for example: @@ -53,7 +51,7 @@ KINXIB21,SR1,2022-09-05 00:00:00,2022-10-21 23:59:00,TP,INXIB21A42,5 ### Use this script with caution The only life jacket of this script is that it prints a warning if the number of fetched events is not the expected one for each course request. -The script works for all the courses I give (BAS, SR1, SR2, Parallélisme) as I write these lines (2022-09-11). +The script works for all the courses I give as I write these lines (2024-10-07). However, the approach is not robust so it may break when: - There is a CELCAT server update (REST API break) - There is a change on how CELCAT events are formatted in the UT3 database (description parsing is hardcoded and not robust)