endpoints & readme file updated + format & minor fixes

Author: Yash2003Bisht

Readme.md

@@ -1,16 +1,25 @@
 # CodeChefAPI
-The codechef API is for educational purposes only. [Heroku deployment](https://codechef-api-education-only.herokuapp.com)
+With CodeChef API you can get stats, contest details, all solved question links, and submission details for any user.
 
 ## Endpoints
-1. user-stats/<user_name>
-2. contest-details/<user_name>
-3. solved/<user_name>
-4. submission-details/<user_name>
+1. user-stats
+2. contest-details
+3. solved
+4. submission-details
 
 ### user-stats
 Returns brief details about the user, such as the total number of contests participated, country, division, global rank, etc.
 
-#### sample
+#### sample code
+```pycon
+import requests
+
+url = "https://domain.com/user-stats"
+res = requests.post(url, headers={"username": "yash2003bisht"})
+print(res.json())
+```
+
+#### sample response
 ```json lines
 {
   "codechef_pro_plan": "No Active Plan",
@@ -32,6 +41,17 @@ Returns brief details about the user, such as the total number of contests parti
 
 ### contest-details
 Returns all details about user contests participated.
+
+#### sample code
+```pycon
+import requests
+
+url = "https://domain.com/contest-details"
+res = requests.post(url, headers={"username": "yash2003bisht"})
+print(res.json())
+```
+
+#### sample response
 ```json lines
 {
   "contest_details": [
@@ -64,6 +84,17 @@ Returns all details about user contests participated.
 
 ### solved
 Returns a list of links containing all questions solved by user.
+
+#### sample code
+```pycon
+import requests
+
+url = "https://domain.com/solved"
+res = requests.post(url, headers={"username": "yash2003bisht"})
+print(res.json())
+```
+
+#### sample response
 ```json lines
 {
   "solved_links": [
@@ -75,6 +106,17 @@ Returns a list of links containing all questions solved by user.
 
 ### submission-details
 Returns data from the submissions graph section.
+
+#### sample code
+```pycon
+import requests
+
+url = "https://domain.com/submission-details"
+res = requests.post(url, headers={"username": "yash2003bisht"})
+print(res.json())
+```
+
+#### sample response
 ```json lines
 {
   "compile_error": 1,
@@ -86,4 +128,4 @@ Returns data from the submissions graph section.
 }
 ```
 
-*Note*: The **submission-details** and **contest-details** endpoints may take longer to fetch the data, as the data are loaded dynamically, and we are using selenium to scrape it.
+*Note*: **submission-details** endpoints may take a longer time to fetch data, as there is some animation in data that delays loading graph details, so we are using **selenium** to scrape it.

src/API/endpoints.py

@@ -10,10 +10,10 @@ def root():
     data = {
         'message': 'Welcome to codechefAPI, this api is for educational purpose only',
         'endpoints': {
-            'user-stats/<user_profile_name>': 'return user profile data details',
-            'solved/<user_profile_name>': 'return user all solved question links',
-            'submission-details/<user_profile_name>': 'return details from submission graph',
-            'contest-details/<user_profile_name>': 'return user all contest participation details'
+            'user-stats': 'return user profile data details',
+            'solved': 'return user all solved question links',
+            'submission-details': 'return details from submission graph',
+            'contest-details': 'return user all contest participation details'
         }
     }
     return jsonify(data)

src/scraping_code/codechef_core_api_endpoints.py

@@ -1,5 +1,5 @@
 from helper_functions import get_response
-
+from typing import Any
 
 headers = {
     "authority": "www.codechef.com",
@@ -24,7 +24,7 @@
 }
 
 
-def contest_endpoint(contest_name: str, username: str) -> dict:
+def contest_endpoint(contest_name: str, username: str) -> Any:
     """Codechef contest details endpoint
 
     Args:
@@ -38,7 +38,8 @@ def contest_endpoint(contest_name: str, username: str) -> dict:
 
     # add aditional details
     headers["path"] = f"/api/rankings/{contest_name}?itemsPerPage=100&order=asc&page=1&search={username}&sortBy=rank"
-    headers["referer"] = f"https://www.codechef.com/rankings/{contest_name}?itemsPerPage=100&order=asc&page=1&search={username}&sortBy=rank"
+    headers[
+        "referer"] = f"https://www.codechef.com/rankings/{contest_name}?itemsPerPage=100&order=asc&page=1&search={username}&sortBy=rank"
 
     res_data = get_response(url, "json", headers)
     details = {}
@@ -49,27 +50,25 @@ def contest_endpoint(contest_name: str, username: str) -> dict:
         details['rank'] = res_data['list'][0]['rank']
         details['total_score'] = res_data['list'][0]['score']
 
-        problems_solved  = {}
+        problems_solved = {}
         total_problems = []
         total_solved = 0
 
         for key, value in res_data['list'][0]["problems_status"].items():
             problems_solved[key] = value
             problems_solved[key]['question_link'] = f"https://www.codechef.com/LP1TO201/problems/{key}"
             problems_solved[key]['submission_link'] = \
-                            f"https://www.codechef.com/rankings/{contest_name}/bestsolution/{key},{username}"
+                f"https://www.codechef.com/rankings/{contest_name}/bestsolution/{key},{username}"
             total_solved += 1
-        
+
         for problem in res_data['problems']:
             data = problem
             data['question_link'] = f"https://www.codechef.com/LP1TO201/problems/{data['code']}"
             total_problems.append(data)
 
-        
         details['problems_solved'] = problems_solved
         details['total_problems'] = total_problems
         details['total_solved'] = total_solved
-        
 
         return details
 

src/scraping_code/profile_scraper.py

@@ -20,7 +20,6 @@ def get_all_solved_links(username: str) -> dict:
     """
     url = f'{BASE_URL}/users/{username}'
     soup = get_response(url)
-    links = []
 
     try:
         # get all solved questions links