Add problem content template definition as program argument

Author: NeverMendel

.github/workflows/publish-docker-image.yml

@@ -9,6 +9,7 @@ on:
 
 jobs:
   publish-image:
+    name: Publish Image
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

README.md

@@ -8,9 +8,7 @@ The problems hosted on leetcode.com are intellectual propriety of LeetCode LLC u
 UPLOAD THE DESCRIPTION OF LEETCODE PROBLEMS ON GITHUB OR ON ANY OTHER WEBSITE** or you might receive ad DMCA Takedown
 notice.
 
-Before using this script make read [LeetCode Terms of Service](https://leetcode.com/terms/).
-
-To avoid committing the problem description on git, you can add `*.txt` to your `.gitignore` file.
+Before using this script read the [LeetCode Terms of Service](https://leetcode.com/terms/).
 
 ## How it works
 
@@ -97,6 +95,7 @@ The script accepts the following arguments:
 ```
 usage: leetcode-export [-h] [--cookies COOKIES] [--folder FOLDER]
                        [--problem-filename PROBLEM_FILENAME]
+                       [--problem-content PROBLEM_CONTENT]
                        [--submission-filename SUBMISSION_FILENAME] [-v] [-vv]
                        [-V]
 
@@ -108,6 +107,8 @@ optional arguments:
   --folder FOLDER       set output folder
   --problem-filename PROBLEM_FILENAME
                         problem description filename format
+  --problem-content PROBLEM_CONTENT
+                        problem description content format
   --submission-filename SUBMISSION_FILENAME
                         submission filename format
   -v, --verbose         enable verbose logging details
@@ -139,7 +140,26 @@ title: str
 title_slug: str
 ```
 
-Default problem description filename template: `${question_id} - ${title_slug}.txt`
+Default problem description filename template: `${question_id} - ${title_slug}.html`
+
+### Problem description content template
+
+To change the format of the problem description content, you can provide a template as a string when lunching the
+script.
+
+```bash
+python leetcode-export --problem-content PROBLEM_CONTENT
+```
+
+The template can contain parameters that will later be replaced based on the LeetCode problem information. The available
+parameters are the ones used in [problem description filename template](#problem-description-filename-template) plus:
+
+```python
+content: str
+```
+
+Default problem description content
+template: `<h1>${question_id} - ${title}</h1><h2>Difficulty: ${difficulty} - <a href="https://leetcode.com/problems/${title_slug}/">${title_slug}</a></h2>${content}`
 
 ### Submission filename template
 

leetcode_export/__main__.py

@@ -7,19 +7,17 @@
 from leetcode_export._version import __version__
 from leetcode_export.leetcode import LeetCode
 
-PROBLEM_CONTENT_TEMPLATE = Template('''${question_id} - ${title}
-${difficulty} - https://leetcode.com/problems/${title_slug}/
-
-${content}
-''')
-
 
 def parse_args():
     parser = argparse.ArgumentParser(description='Export LeetCode solutions')
     parser.add_argument('--cookies', type=str, help='set LeetCode cookies')
     parser.add_argument('--folder', type=str, default='.', help='set output folder')
-    parser.add_argument('--problem-filename', type=str, default='${question_id} - ${title_slug}.txt',
+    parser.add_argument('--problem-filename', type=str, default='${question_id} - ${title_slug}.html',
                         help='problem description filename format')
+    parser.add_argument('--problem-content', type=str,
+                        default='<h1>${question_id} - ${title}</h1><h2>Difficulty: ${difficulty} - ' +
+                                '<a href="https://leetcode.com/problems/${title_slug}/">${title_slug}</a></h2>${content}',
+                        help='problem description content format')
     parser.add_argument('--submission-filename', type=str,
                         default='${date_formatted} - ${status_display} - runtime ${runtime} - memory ${memory}.${extension}',
                         help='submission filename format')
@@ -53,6 +51,7 @@ def main():
     )
 
     problem_template = Template(args.problem_filename)
+    problem_content_template = Template(args.problem_content)
     submission_template = Template(args.submission_filename)
 
     leetcode = LeetCode()
@@ -83,7 +82,7 @@ def main():
             info_filename = problem_template.substitute(**problem.__dict__)
             if not os.path.exists(info_filename):
                 info_file = open(info_filename, 'w+')
-                info_file.write(PROBLEM_CONTENT_TEMPLATE.substitute(**problem.__dict__))
+                info_file.write(problem_content_template.substitute(**problem.__dict__))
                 info_file.close()
             written_problems.add(submission.title_slug)
 

leetcode_export/_version.py

@@ -1 +1 @@
-__version__ = '1.1.1'
+__version__ = '1.2.0'