rushilwiz/SkoolOS
1
0
Fork 0
mirror of https://github.com/Rushilwiz/SkoolOS.git synced 2025-04-18 11:20:19 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

redocumented teacher.py

Browse Source
This commit is contained in:
Nathaniel Kenschaft 2020-06-16 20:21:30 -04:00
parent 65a35b540b
commit 9d02b3dd3b
1 changed files with 24 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
CLI/teacher.py
View File

@ -30,7 +30,7 @@ def getTeacher(ion_user, password):
""" """
Gets information about a teacher from the api Gets information about a teacher from the api
:param ion_user: a teacher :param ion_user: a teacher
:param password: a string :param password: the teacher's password
:return: teacher information or error :return: teacher information or error
""" """
URL = "http://127.0.0.1:8000/api/teachers/" + ion_user + "/" URL = "http://127.0.0.1:8000/api/teachers/" + ion_user + "/"
@ -52,10 +52,11 @@ def getTeacher(ion_user, password):
#makes a GET request to given url, returns dict #makes a GET request to given url, returns dict
def getDB(user, pwd, url): def getDB(user, pwd, url):
""" """
Sends a GET request to the URL Sends a GET request to url
:param user: a string :param user: username
:param password: a string :param pwd: password
:param url: URL for request :param url: URL for request
:return: json request response
""" """
r = requests.get(url=url, auth=(user, pwd)) r = requests.get(url=url, auth=(user, pwd))
print("GET:" + str(r.status_code)) print("GET:" + str(r.status_code))
@ -64,11 +65,12 @@ def getDB(user, pwd, url):
#makes a PATCH (updates instance) request to given url, returns dict #makes a PATCH (updates instance) request to given url, returns dict
def patchDB(user, pwd, data, url): def patchDB(user, pwd, data, url):
""" """
Sends a PATCH request to the URL Sends a PATCH request to url
:param data: :param user: username
:param user: a string :param pwd: password
:param password: a string
:param url: URL for request :param url: URL for request
:param data: data to request
:return: json request response
""" """
r = requests.patch(url=url, data=data, auth=(user, pwd)) r = requests.patch(url=url, data=data, auth=(user, pwd))
print("PATCH:" + str(r.status_code)) print("PATCH:" + str(r.status_code))
@ -78,11 +80,12 @@ def patchDB(user, pwd, data, url):
#makes a POST (makes new instance) request to given url, returns dict #makes a POST (makes new instance) request to given url, returns dict
def postDB(user, pwd, data, url): def postDB(user, pwd, data, url):
""" """
Sends a POST request to the URL Sends a POST request to url
:param data: :param user: username
:param user: a string :param pwd: password
:param password: a string
:param url: URL for request :param url: URL for request
:param data: data to request
:return: json request response
""" """
r = requests.post(url=url, data=data, auth=(user, pwd)) r = requests.post(url=url, data=data, auth=(user, pwd))
print("POST:" + str(r.status_code)) print("POST:" + str(r.status_code))
@ -92,10 +95,12 @@ def postDB(user, pwd, data, url):
#makes a PUT (overwrites instance) request to given url, returns dict #makes a PUT (overwrites instance) request to given url, returns dict
def putDB(user, pwd, data, url): def putDB(user, pwd, data, url):
""" """
Sends a PUT request to the URL Sends a PUT request to url
:param user: a string :param user: username
:param password: a string :param pwd: password
:param url: URL for request :param url: URL for request
:param data: data to request
:return: json request response
""" """
r = requests.put(url=url, data=data, auth=(user, pwd)) r = requests.put(url=url, data=data, auth=(user, pwd))
print("PUT:" + str(r.status_code)) print("PUT:" + str(r.status_code))
@ -105,10 +110,11 @@ def putDB(user, pwd, data, url):
#makes a DELETE (delete instance) request to given url, returns dict #makes a DELETE (delete instance) request to given url, returns dict
def delDB(user, pwd, url): def delDB(user, pwd, url):
""" """
Sends a DELETE request to the URL Sends a DELETE request to url
:param user: a string :param user: username
:param password: a string :param pwd: password
:param url: URL for request :param url: URL for request
:return: json request response
""" """
r = requests.delete(url=url, auth=(user, pwd)) r = requests.delete(url=url, auth=(user, pwd))
print("DELETE:" + str(r.status_code)) print("DELETE:" + str(r.status_code))