diff --git a/docs/source/cli.rst b/docs/source/cli.rst index 23c9ed8..db5c303 100644 --- a/docs/source/cli.rst +++ b/docs/source/cli.rst @@ -1,10 +1,10 @@ Command Line Interface ===================== -1. Making a user: +Making a user: ------- - -python skoolos.py +:: + python skoolos.py You will be redirected to a login page for the SkoolOS website. If you have already created an account on the website, enter login informatiton. If not, select the registration button bellow and create an account. Once you create an account via Ion OAuth and SkoolOS, login. The window should close, prompting: @@ -19,12 +19,12 @@ Enter the valid SkoolOS username and password. Congratialations, you have succes 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 +.. code-block:: python + 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: @@ -35,7 +35,7 @@ You will then be given the choice to select an existing class, Make a new class, Make New Class Exit SkoolOS -1. Making a new class: +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). @@ -59,8 +59,62 @@ one username per line. 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 + +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.) + +? 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 diff --git a/eharris1/Truck_eharris1/README.md b/eharris1/Truck_eharris1/README.md new file mode 100644 index 0000000..e69de29 diff --git a/skoolos.py b/skoolos.py index 10962e2..097cd2b 100644 --- a/skoolos.py +++ b/skoolos.py @@ -1,6 +1,3 @@ -""" -The main program file for SkoolOS -""" import sys from urllib.parse import urlparse import requests @@ -439,7 +436,7 @@ def viewStudentsTeacher(teacher, course): "http://127.0.0.1:8000/api/classes/" + course) students = data["confirmed"] unconf = data['unconfirmed'] - print("Studented in class: ") + print("Students in class: ") for s in students: print(s) print("Requsted Students: ") @@ -470,6 +467,7 @@ def viewStudentsTeacher(teacher, course): s = f.split("_")[0] alist.append(s) print("Has submitted: " + str(alist)) + #Y/N #put log stuff