From 8f8e55acdb9b1b9496b97549a8add63879683a73 Mon Sep 17 00:00:00 2001 From: Nathaniel Kenschaft Date: Tue, 16 Jun 2020 23:36:19 -0400 Subject: [PATCH 1/3] polised install and cli documentation --- docs/source/cli.rst | 14 ++++++-------- docs/source/install.rst | 14 +++++++------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/source/cli.rst b/docs/source/cli.rst index c139eaf..4b31d74 100644 --- a/docs/source/cli.rst +++ b/docs/source/cli.rst @@ -25,7 +25,8 @@ Start the CLI and select your username. For instance, teacher 'eharris1':: ❯ 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 @@ -122,7 +123,7 @@ To add an assignment, make an assginment subdirectory in the corresponding class eharris1/English12_eharris1/Assignment1/instruct.txt -You must also put a due date in the correct format. +You must also put a due date in the correct format.:: ? Select new assignment: Assignment1 Enter due date (Example: 2020-08-11 16:58): 2020-08-11 16:58 @@ -132,7 +133,7 @@ View student information You can view certain information of any student requested or confirmed in the given class. Simply select enter their name and see their profile. You are also given the choice to view their logs (files they have saved, written, git commands, and file that dont match the extention whitelist). Note that as a teacher, you can view a student's current -work at ANY TIME. Simply go to the 'Students' directory and select the student's directory. +work at ANY TIME. Simply go to the 'Students' directory and select the student's directory.:: eharris1/Students/English12_eharris1/2022rkhondak eharris1/Students/English12_eharris1/2023rumareti @@ -154,7 +155,7 @@ work at ANY TIME. Simply go to the 'Students' directory and select the student's ============ As a student, you can edit your work for certain classes and submit assignments. By default, your workr directory (your username) has a single readme. AND IT SHOULD STAY THAT WAY. -To make changes to a class, you must first select that class via the CLI. +To make changes to a class, you must first select that class via the CLI.:: Select a class first: ? Select class: (Use arrow keys) @@ -165,6 +166,7 @@ To make changes to a class, you must first select that class via the CLI. You can then view the assignments associated with the class. Open you work directory and modify files within your assignments. At any time, you can 'Save' or go 'Back'. When you are ready, you can submit an assignment: +:: ? Select: (Use arrow keys) Save @@ -175,7 +177,3 @@ When you are ready, you can submit an assignment: ? Select: (Use arrow keys) Assignment1 ❯ Back - -2. CLI as a student: -============ - diff --git a/docs/source/install.rst b/docs/source/install.rst index 55dce84..85b8170 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -4,13 +4,13 @@ Installation Git clone repository: ------- -https://gitlab.tjhsst.edu/understudyathon-2020/group-1/schoolos.git +https://gitlab.tjhsst.edu/understudyathon-2020/group-1/skoolos.git Install repository and create env ------- - -cd SkoolOS -python3 -m venv env -source env/bin/activate -pip install -r requirements.txt - +Run the following commands in order to install SkoolOS: +:: + cd SkoolOS + python3 -m venv env + source env/bin/activate + pip install -r requirements.txt From 5fb88d04086f7697285ed7b55f63e7209ae1c897 Mon Sep 17 00:00:00 2001 From: Nathaniel Kenschaft Date: Tue, 16 Jun 2020 23:40:05 -0400 Subject: [PATCH 2/3] polised install and cli documentation --- docs/source/cli.rst | 1 + docs/source/install.rst | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/source/cli.rst b/docs/source/cli.rst index 4b31d74..6fe0a0c 100644 --- a/docs/source/cli.rst +++ b/docs/source/cli.rst @@ -120,6 +120,7 @@ Adding an assignment ------- To add an assignment, make an assginment subdirectory in the corresponding class wiht at least 1 file. Somehting like: +:: eharris1/English12_eharris1/Assignment1/instruct.txt diff --git a/docs/source/install.rst b/docs/source/install.rst index 85b8170..69e8cb3 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -10,6 +10,7 @@ Install repository and create env ------- Run the following commands in order to install SkoolOS: :: + git clone https://gitlab.tjhsst.edu/understudyathon-2020/group-1/skoolos.git SkoolOS cd SkoolOS python3 -m venv env source env/bin/activate From 5dbcd828b0b346d2526b1c9ef82dc42b45bd9577 Mon Sep 17 00:00:00 2001 From: Raffu Khondaker <2022rkhondak@tjhsst.edu> Date: Tue, 16 Jun 2020 23:50:20 -0400 Subject: [PATCH 3/3] final push --- CLI/teacher.py | 2 +- Website/api/serializers.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CLI/teacher.py b/CLI/teacher.py index 348aa4d..616521b 100644 --- a/CLI/teacher.py +++ b/CLI/teacher.py @@ -569,7 +569,7 @@ class Teacher: 'due_date': str(due), 'owner':self.id } - postDB(self.username, self.password, ass, 'http://127.0.0.1:8000/api/assignments/') + print(postDB(self.username, self.password, ass, 'http://127.0.0.1:8000/api/assignments/')) course['assignments'].append(oname) cinfo = { diff --git a/Website/api/serializers.py b/Website/api/serializers.py index 077a634..d4ff4ad 100644 --- a/Website/api/serializers.py +++ b/Website/api/serializers.py @@ -25,7 +25,7 @@ class AssignmentSerializer(serializers.HyperlinkedModelSerializer): class Meta: model = Assignment # fields = ['url','name', 'due_date', 'path' , "Class","teacher",'owner'] - fields = ['name', 'due_date', 'path' ,"teacher",'owner'] + fields = ['name', 'due_date', 'path' ,'teacher','owner'] class ClassSerializer(serializers.ModelSerializer): # assignments = AssignmentSerializer(many=True, read_only=True,allow_null=True)