diff --git a/docs/source/cli.rst b/docs/source/cli.rst index db5c303..18b0990 100644 --- a/docs/source/cli.rst +++ b/docs/source/cli.rst @@ -17,23 +17,22 @@ Enter the valid SkoolOS username and password. Congratialations, you have succes 1. CLI as a teacher: ============ -Start the CLI and select your username. For instance, teacher 'eharris1' - -.. code-block:: python +Start the CLI and select your username. For instance, teacher 'eharris1':: + python skoolos.py ? Select User: (Use arrow keys) 1) 2022rkhondak ❯ 2) eharris1 3) Make new user -You will then be given the choice to select an existing class, Make a new class, or exit the CLI: +You will then be given the choice to select an existing class, Make a new class, or exit the CLI::: -? Select class: (Use arrow keys) - ❯ Art12_eharris1 - English12_eharris1 - History12_eharris1 - Make New Class - Exit SkoolOS + ? Select class: (Use arrow keys) + ❯ Art12_eharris1 + English12_eharris1 + History12_eharris1 + Make New Class + Exit SkoolOS Making a new class: ------- @@ -41,85 +40,77 @@ Making a new class: Select 'Make a New Class'. You will then be prompted to enter a class name. The format for every class must be _ (Example: Art12_eharris1). Enter Period (must be a positive integer). You will then be prompted to add students. If you have a list of students, enter the relative path of a text file with the student usernames. The file must be a .txt file and have one student username per line. If you add an individual student, simply enter their ion username. -one username per line. +one username per line.:: -? Select class: (Use arrow keys) - Art12_eharris1 - English12_eharris1 - History12_eharris1 - ❯ Make New Class - Exit SkoolOS + ? Select class: (Use arrow keys) + Art12_eharris1 + English12_eharris1 + History12_eharris1 + ❯ Make New Class + Exit SkoolOS + + ? Add Students): (Use arrow keys) + ❯ 1) Add individual student + 2) Add list of students through path + 3) Exit + + ? Add Students): 2) Add list of students through path + File must be .txt and have 1 student username per line + Relative Path: students.txt -? Add Students): (Use arrow keys) - ❯ 1) Add individual student - 2) Add list of students through path - 3) Exit +OR:: -? Add Students): 2) Add list of students through path -File must be .txt and have 1 student username per line -Relative Path: students.txt - -OR - -? Add Students): 1) Add individual student -Student name: 2022rkhondak + ? Add Students): 1) Add individual student + Student name: 2022rkhondak Accessing an existing class ===================== Once you have created a class, you can then view and modify certain fields. (Open opening a class, any students who have accepted the request will be automatically -added you the class.) +added you the class.):: -? Select class: (Use arrow keys) - Art12_eharris1 - Civ_eharris1 - ❯ English12_eharris1 - History12_eharris1 - Random_eharris1 - Truck_eharris1 - Make New Class - Exit SkoolOS - -Class: English12_eharris1 -? Select option: (Use arrow keys) - ❯ 1) Request Student - 2) Add assignment - 3) View student information - 4) Exit + ? Select class: (Use arrow keys) + Art12_eharris1 + Civ_eharris1 + ❯ English12_eharris1 + History12_eharris1 + Random_eharris1 + Truck_eharris1 + Make New Class + Exit SkoolOS + + Class: English12_eharris1 + ? Select option: (Use arrow keys) + ❯ 1) Request Student + 2) Add assignment + 3) View student information + 4) Exit Requesting Students ------- Select 'Request Student'. You will then be prompted to add students. If you have a list of students, enter the relative path of a text file with the student usernames. The file must be a .txt file and have one student username per line. If you add an individual student, simply enter their ion username. -one username per line. - -Class: English12_eharris1 -? Select option: (Use arrow keys) - ❯ 1) Request Student - 2) Add assignment - 3) View student information - 4) Exit - -? Add list of students (input path): (Use arrow keys) - ❯ 1) Add individual student - 2) Add list of students through path - 3) Exit - -? Select option: 1) Request Student -? Add list of students (input path): 1) Add individual student -? Student Name: 2022rkhondak - -OR - -? Add Students): 2) Add list of students through path -File must be .txt and have 1 student username per line -Relative Path: students.txt - - - - - +one username per line.:: + Class: English12_eharris1 + ? Select option: (Use arrow keys) + ❯ 1) Request Student + 2) Add assignment + 3) View student information + 4) Exit + + ? Add list of students (input path): (Use arrow keys) + ❯ 1) Add individual student + 2) Add list of students through path + 3) Exit + + ? Select option: 1) Request Student + ? Add list of students (input path): 1) Add individual student + ? Student Name: 2022rkhondak +OR:: + ? Add Students): 2) Add list of students through path + File must be .txt and have 1 student username per line + Relative Path: students.txt