Add methods documentation

Author: NeverMendel

README.md

@@ -27,8 +27,8 @@ To use it locally you can either download it from pypi.org or you can clone this
 
 ## Download from pypi.org
 
-Execute `py install leetcode-export` to download it and install all the needed dependencies. You might need to use `py3`
-depending on how python is configured in your system.
+Execute `pip install leetcode-export` to download it and install all the needed dependencies. You might need to use `pip3`
+depending on the configuration of your system.
 
 ### Clone the repository
 
@@ -75,19 +75,16 @@ docker run -it -v $(pwd):/usr/app/out --rm nevermendel/leetcode-export
 The script accepts the following arguments:
 
 ```
-usage: leetcode-export [-h] [--username USERNAME] [--password PASSWORD]
-                       [--folder FOLDER] [--cookies COOKIES] [-v] [-vv]
+usage: leetcode-export [-h] [--cookies COOKIES] [--folder FOLDER] [-v] [-vv]
                        [--problem-filename PROBLEM_FILENAME]
                        [--submission-filename SUBMISSION_FILENAME]
 
 Export LeetCode solutions
 
 optional arguments:
   -h, --help            show this help message and exit
-  --username USERNAME   Set LeetCode username
-  --password PASSWORD   Set LeetCode password
-  --folder FOLDER       Output folder
   --cookies COOKIES     Set LeetCode cookies
+  --folder FOLDER       Output folder
   -v, --verbose         Enable verbose logging details
   -vv, --extra-verbose  Enable more verbose logging details
   --problem-filename PROBLEM_FILENAME

leetcode_export/leetcode.py

@@ -37,6 +37,11 @@ def log_in(self, username: str, password: str) -> bool:
             return False
 
     def set_cookies(self, cookies: str) -> bool:
+        '''
+        Log in to LeetCode using cookies
+        :param cookies: string with cookies to set
+        :return: bool, true if login is successful, false otherwise
+        '''
         cookies_list = cookies.split(';')
         cookies_list = map(lambda el: el.split('='), cookies_list)
         for cookies in cookies_list:
@@ -49,6 +54,10 @@ def set_cookies(self, cookies: str) -> bool:
             return False
 
     def is_user_logged(self) -> bool:
+        '''
+        Check if user is logged in LeetCode account
+        :return: bool, true if user is logged in, false otherwise
+        '''
         if self.user_logged and datetime.datetime.now() < self.user_logged_expiration:
             return True
         cookie_dict = self.session.cookies.get_dict()
@@ -64,6 +73,11 @@ def is_user_logged(self) -> bool:
         return False
 
     def get_problem(self, slug: str) -> Problem:
+        '''
+        Get LeetCode problem info
+        :param slug: problem identifier
+        :return: Problem
+        '''
         response = self.session.post(
             GRAPHQL_URL,
             json=question_detail_json(slug))
@@ -72,6 +86,10 @@ def get_problem(self, slug: str) -> Problem:
             return Problem.from_dict(problem_dict)
 
     def get_submissions(self) -> Dict[str, List[Submission]]:
+        '''
+        Get list of submission for logged user
+        :return: Dict[str, List[Submission]], dictionary with slug as key and submission for given problem as value
+        '''
         if not self.is_user_logged():
             logging.warning("Trying to get user submissions while user is not logged in")
             return {}
@@ -86,7 +104,8 @@ def get_submissions(self) -> Dict[str, List[Submission]]:
                 for submission_dict in response_json['submissions_dump']:
                     submission_dict['runtime'] = submission_dict['runtime'].replace(' ', '')
                     submission_dict['memory'] = submission_dict['memory'].replace(' ', '')
-                    submission_dict['date_formatted'] = datetime.datetime.fromtimestamp(submission_dict['timestamp']).strftime(
+                    submission_dict['date_formatted'] = datetime.datetime.fromtimestamp(
+                        submission_dict['timestamp']).strftime(
                         '%Y-%m-%d %H.%M.%S')
                     submission_dict['extension'] = language_to_extension(submission_dict['lang'])
                     for key in submission_dict:

leetcode_export/utils.py

@@ -30,21 +30,41 @@
 
 
 def language_to_extension(language: str) -> str:
+    '''
+    Return extension format for given programming language
+    :param language: programming language
+    :return: str extension format
+    '''
     return FILE_EXTENSIONS[language]
 
 
 def remove_special_characters(string: str) -> str:
+    '''
+    Returns a new string where without any character that is not allowed in windows filenames
+    :param string: string to process
+    :return: str string without special characters
+    '''
     for el in SPECIAL_CHARACTERS_FILENAME:
         string = string.replace(el, '')
     return string
 
 
 def camelcase_to_snakecase(string: str) -> str:
+    '''
+    Returns a new string transforming a CamelCase string into snake_case
+    :param string: CamelCase string to process
+    :return: str snake_case string
+    '''
     subbed = _regex_camelcase_to_snakecase1.sub(r'\1_\2', string)
     return _regex_camelcase_to_snakecase2.sub(r'\1_\2', subbed).lower()
 
 
 def dict_camelcase_to_snakecase(dictionary: Dict[str, any]) -> Dict[str, any]:
+    '''
+    Returns a new dictionary where keys are transformed from CamelCase into snake_case
+    :param dictionary: original dictionary
+    :return: Dict[str, any] new dictionary with snake_case keys
+    '''
     new_dict: Dict[str, any] = {}
     for key in dictionary:
         new_dict[camelcase_to_snakecase(key)] = dictionary[key]