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

fixed skoolos.py documentation and redocumented student.py

Browse Source
This commit is contained in:
Nathaniel Kenschaft 2020-06-16 20:08:06 -04:00
parent 381e9b702f
commit 65a35b540b
2 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
CLI/student.py
View File

@ -32,8 +32,11 @@ def getStudent(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: username
: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))
@ -42,9 +45,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 pwd: password
: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))
@ -54,9 +60,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 pwd: password
: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))
@ -66,10 +75,13 @@ 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 data: :param user: username
: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))
return r.json() return r.json()
@ -78,8 +90,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: username
: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))

2
skoolos.py
View File

@ -505,7 +505,6 @@ def getDB(USER, PWD, url):
:param USER: username :param USER: username
:param PWD: password :param PWD: password
:param url: URL for request :param url: URL for request
:param data: data to request
:return: json request response :return: json request response
""" """
r = requests.get(url=url, auth=(USER, PWD)) r = requests.get(url=url, auth=(USER, PWD))
@ -547,7 +546,6 @@ def delDB(USER, PWD, url):
:param USER: username :param USER: username
:param PWD: password :param PWD: password
:param url: URL for request :param url: URL for request
:param data: data to request
:return: json request response :return: json request response
""" """
r = requests.delete(url=url, auth=(USER, PWD)) r = requests.delete(url=url, auth=(USER, PWD))