Add interactive menu to log in and add filename template format arguments

Author: NeverMendel

README.md

@@ -1,6 +1,6 @@
 # LeetCode Export
 
-> Python script and Docker image to export your LeetCode solutions
+Python script and Docker image to export your LeetCode solutions.
 
 ## DISCLAIMER
 
@@ -32,47 +32,56 @@ pip install -r requirements.txt
 
 ### Docker Image
 
-To use the Docker Image you first need to download it from the Docker repository by running:
+Download the docker image from the DockerHub repository:
 
 ```bash
 docker pull nevermendel/leetcode-export
 ```
 
-Now you can download all your LeetCode submission in the current folder by executing:
+Download all your LeetCode submission in the current folder:
 
 ```bash
 docker run -it -v $(pwd):/usr/app/out --rm nevermendel/leetcode-export
 ```
 
-## App parameters
+## Script arguments
 
-The script accepts the following parameters:
+The script accepts the following arguments:
 
 ```bash
 usage: app.py [-h] [--username USERNAME] [--password PASSWORD]
               [--folder FOLDER] [--cookies COOKIES] [-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   LeetCode username
-  --password PASSWORD   LeetCode password
+  --username USERNAME   Set LeetCode username
+  --password PASSWORD   Set LeetCode password
   --folder FOLDER       Output folder
-  --cookies COOKIES     LeetCode cookies
+  --cookies COOKIES     Set LeetCode cookies
   -v, --verbose         Enable verbose logging details
   -vv, --extra-verbose  Enable more verbose logging details
+  --problem-filename PROBLEM_FILENAME
+                        Problem description filename format
+  --submission-filename SUBMISSION_FILENAME
+                        Submission filename format
 ```
 
 ## Login
 
-There are two ways to login in your LeetCode account, by providing username and password or by passing the cookies as
-program argument.
+To download your submissions you need to log in your LeetCode account. There are two ways to log in, by
+username/password or by cookies.
 
-### Username and Password
+You can either use the interactive menu to supply the required information or you can pass them as program arguments
+when lunching the script.
 
-To login using username and password, insert them when prompted or pass them as parameter when lunching the script, like
-in the following example:
+### Username/Password
+
+To log in using username and password, insert them using the interactive menu (preferred) or pass them as arguments when
+lunching the script, like in the following example:
 
 ```bash
 python ./app.py --username {USERNAME} --password {PASSWORD}`
@@ -82,13 +91,69 @@ The former option is to be preferred as it will avoid storing your password in t
 
 ### Cookies
 
-To login using cookies, pass the string containing them as parameter when lunching the script, like in the following
+To log in using cookies, pass the string containing them as arguments when lunching the script, like in the following
 example:
 
 ```bash
 python ./app.py --cookies {COOKIES}
 ```
 
+## Filename template arguments
+
+### Problem description filename template
+
+To change the format of the problem description filename, you can provide a template as a string when lunching the
+script.
+
+```bash
+python ./app.py --problem-filename PROBLEM_FILENAME
+```
+
+The template can contain parameters that will later be replaced based on the LeetCode problem information. The available
+parameters are the following:
+
+```python
+questionId: int
+difficulty: str
+stats: str
+title: str
+titleSlug: str
+```
+
+Default problem description filename template: `${questionId} - ${titleSlug}.txt`
+
+### Submission filename template
+
+To change the format of the submission filename, you can provide a template as a string when lunching the script.
+
+```bash
+python ./app.py --submission-filename SUBMISSION_FILENAME
+```
+
+The template can contain parameters that will later be replaced based on your submission information. The available
+parameters are the following:
+
+```python
+id: int
+lang: str
+time: str
+timestamp: int
+status_display: str
+runtime: str
+url: str
+is_pending: str
+title: str
+memory: str
+code: str
+compare_result: str
+title_slug: str
+date_formatted: str
+extension: str
+```
+
+Default submission filename
+template: `${date_formatted} - ${status_display} - runtime ${runtime} - memory ${memory}.${extension}`
+
 ## Special mentions
 
 Thanks to [skygragon](https://github.com/skygragon) for

leetcode-export/app.py

@@ -3,15 +3,13 @@
 import getpass
 import logging
 import os
-from datetime import datetime
 from string import Template
 from typing import List, Dict
 
 from leetcode import LeetCode
 from leetcode_rest import Submission
-from utils import language_to_extension, remove_special_characters
 
-PROBLEM_INFO_TEMPLATE = Template('''${questionId} - ${title}
+PROBLEM_CONTENT_TEMPLATE = Template('''${questionId} - ${title}
 ${difficulty} - https://leetcode.com/problems/${titleSlug}/
 
 ${content}
@@ -20,13 +18,18 @@
 
 def parse_args():
     parser = argparse.ArgumentParser(description='Export LeetCode solutions')
-    parser.add_argument('--username', type=str, required=False, help='LeetCode username')
-    parser.add_argument('--password', type=str, required=False, help='LeetCode password')
+    parser.add_argument('--username', type=str, required=False, help='Set LeetCode username')
+    parser.add_argument('--password', type=str, required=False, help='Set LeetCode password')
     parser.add_argument('--folder', type=str, required=False, help='Output folder', default='out')
-    parser.add_argument('--cookies', type=str, required=False, help='LeetCode cookies')
+    parser.add_argument('--cookies', type=str, required=False, help='Set LeetCode cookies')
     parser.add_argument('-v', '--verbose', dest='verbose', action='store_true', help='Enable verbose logging details')
     parser.add_argument('-vv', '--extra-verbose', dest='extra_verbose', action='store_true',
                         help='Enable more verbose logging details')
+    parser.add_argument('--problem-filename', type=str, default='${questionId} - ${titleSlug}.txt',
+                        help='Problem description filename format')
+    parser.add_argument('--submission-filename', type=str,
+                        default='${date_formatted} - ${status_display} - runtime ${runtime} - memory ${memory}.${extension}',
+                        help='Submission filename format')
     parser.set_defaults(verbose=False, extra_verbose=False)
 
     return parser.parse_args()
@@ -51,23 +54,40 @@ class App(object):
         ]
     )
 
-    leetcode = LeetCode()
+    problem_template = Template(args.problem_filename)
+    submission_template = Template(args.submission_filename)
 
-    if not args.cookies:
-        username = args.username
-        password = args.password
-
-        if not username:
+    leetcode = LeetCode()
+    username = ''
+    password = ''
+    cookies = ''
+
+    # Login into leetcode
+    if (not args.username or not args.password) and not args.cookies:
+        choice = input("How do you want to login?\n  1 - Username and Password\n  2 - Cookies\n")
+        while choice != '1' and choice != '2':
+            print("Choice not valid, input 1 or 2")
+            choice = input("How do you want to login?\n  1 - Username and Password\n  2 - Cookies\n")
+
+        if choice == '1':
             username = input("Insert LeetCode username: ")
-        if not password:
             password = getpass.getpass(prompt="Insert LeetCode password: ")
-        if not leetcode.log_in(args.username, args.password):
-            print(
-                "Login not successful! You might have entered the wrong username/password or you need to complete the reCAPTCHA. If you need to complete the captcha, log in with the cookies instead. Check the log for more informaton.")
-            exit(1)
+        else:
+            cookies = input("Insert LeetCode cookies: ")
     else:
-        leetcode.set_cookies(args.cookies)
+        username = args.username
+        password = args.password
+        cookies = args.cookies
+
+    if username and password and not leetcode.log_in(args.username, args.password):
+        print(
+            "Login not successful! You might have entered the wrong username/password or you need to complete the reCAPTCHA. If you need to complete the reCAPTCHA, log in with the cookies instead. Check the log for more information.")
+        exit(1)
+
+    if cookies:
+        leetcode.set_cookies(cookies)
 
+    # Create output folder if it doesn't already exist
     if not os.path.exists(args.folder):
         os.mkdir(args.folder)
     os.chdir(args.folder)
@@ -81,15 +101,15 @@ class App(object):
         else:
             logging.info(f"Folder {slug} already exists")
         os.chdir(slug)
-        problem_info = leetcode.get_problem(slug)
-        info_filename = f"{problem_info.questionId} - {slug}.txt"
+        problem_description = leetcode.get_problem(slug)
+        info_filename = problem_template.substitute(**problem_description.__dict__)
         if not os.path.exists(info_filename):
             info_file = open(info_filename, 'w+')
-            info_file.write(PROBLEM_INFO_TEMPLATE.substitute(**problem_info.__dict__))
+            info_file.write(PROBLEM_CONTENT_TEMPLATE.substitute(**problem_description.__dict__))
             info_file.close()
 
         for sub in submissions[slug]:
-            sub_filename = f"{datetime.fromtimestamp(sub.timestamp).strftime('%Y-%m-%d %H.%M.%S')} - {sub.status_display} - runtime {remove_special_characters(sub.runtime)} - memory {remove_special_characters(sub.memory)}.{language_to_extension(sub.lang)}"
+            sub_filename = submission_template.substitute(**sub.__dict__)
             if not os.path.exists(sub_filename):
                 logging.info(f"Writing {slug}/{sub_filename}")
                 sub_file = open(sub_filename, 'w+')

leetcode-export/leetcode.py

@@ -1,11 +1,13 @@
 import logging
+from datetime import datetime
 from time import sleep
 from typing import Dict, List
 
 import requests
 
 from leetcode_graphql import GRAPHQL_URL, question_detail_json, Problem
 from leetcode_rest import LOGIN_URL, SUBMISSIONS_API_URL, Submission, BASE_URL
+from utils import language_to_extension, remove_special_characters
 
 
 class LeetCode(object):
@@ -67,6 +69,14 @@ def get_submissions(self) -> Dict[str, List[Submission]]:
                 headers={'Cookie': self.cookies}).json()
             if 'submissions_dump' in response_json:
                 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.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:
+                        if type(submission_dict[key]) == str and key != 'url' and key != 'code':
+                            submission_dict[key] = remove_special_characters(submission_dict[key])
                     submission = Submission.from_dict(submission_dict)
                     if submission.title_slug not in dictionary:
                         dictionary[submission.title_slug] = []

leetcode-export/leetcode_graphql.py

@@ -10,6 +10,7 @@
 class Problem:
     questionId: int
     difficulty: str
+    stats: str
     title: str
     titleSlug: str
     content: str
@@ -25,6 +26,7 @@ def question_detail_json(slug):
             question(titleSlug: $titleSlug) {
                 questionId
                 difficulty
+                stats
                 title
                 titleSlug
                 content

leetcode-export/leetcode_rest.py

@@ -24,3 +24,5 @@ class Submission:
     code: str
     compare_result: str
     title_slug: str
+    date_formatted: str
+    extension: str

leetcode-export/utils.py

@@ -21,7 +21,7 @@
     "swift": 'swift'
 }
 
-SPECIAL_CHARACTERS_FILENAME = ['/', '\\', ':', '*', '?', '"', '"', '<', '>', ' ', '|']
+SPECIAL_CHARACTERS_FILENAME = ['/', '\\', ':', '*', '?', '"', '"', '<', '>', '|']
 
 
 def language_to_extension(language: str) -> str: