diff --git a/API/Functions.py b/API/Functions.py index 4858e26a571deb8d84f81efbeb0aeaebae4732ca..88ca32cdf02a8461b6e8f7cc76d7d5e28ab059f1 100644 --- a/API/Functions.py +++ b/API/Functions.py @@ -5,6 +5,7 @@ from dotenv import load_dotenv def safe_url(query): + """ convert query to URL-safe style """ load_dotenv() host = os.getenv('SERVER_HOST') return host + Parser.url_safe(query) @@ -24,6 +25,7 @@ def get(query): def put(query, json_file): + """ PUT request """ print("PUT: " + query) url = safe_url(query) req = requests.put(url, json=json_file) @@ -32,6 +34,7 @@ def put(query, json_file): def post(query, json_file): + """ POST request """ print("POST: " + query) url = safe_url(query) req = requests.post(url, json=json_file) @@ -40,6 +43,7 @@ def post(query, json_file): def delete(query): + """ DELETE request """ print("DELETE: " + query) url = safe_url(query) req = requests.delete(url) diff --git a/Crawler/Scrape.py b/Crawler/Scrape.py index a2f97aefca3dde45cec48686887942fcfbc52771..bb0c4a9a300a56ed1cf6d781071880358016993c 100644 --- a/Crawler/Scrape.py +++ b/Crawler/Scrape.py @@ -4,6 +4,7 @@ from DataBase import mongoDB as db def scrape_api(url_api, book_num_api, author_num_api): + """ Function called by other module to run the scraper """ print('Request received, start scraping') book_dict_api = {} author_dict_api = {} diff --git a/DataBase/JsonParser.py b/DataBase/JsonParser.py index 2a5e5247d8663b0d08c0a921c5b79317307d0e26..fa805723b49854ee50c49e375bcbdc2daa4a0c5d 100644 --- a/DataBase/JsonParser.py +++ b/DataBase/JsonParser.py @@ -1,5 +1,6 @@ def parse_book_dict_to_json(dictionary): + """ parse books dictionary to json file """ item_list = list(dictionary.items()) return_list = [] for items in item_list: