Add support for excel format, tqdm for question generation progress

Author: johnsutor

.github/workflows/deploy-docs.yml

@@ -0,0 +1,24 @@
+name: Docs
+on: [push, pull_request, workflow_dispatch]
+permissions:
+    contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme sphinx-argparse
+      - name: Sphinx build
+        run: |
+          sphinx-build doc _build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true

CHANGELOG.md

@@ -1,4 +1,9 @@
 # Changelog 
 
+## 1.2.0
+- Added Neetcode 150 and Neetcode All to presets 
+- Added support for exporting to Excel
+- Added TQDM progress bar to reflect progress of card generation 
+
 ## 1.1.0
 - Added support for using presets of questions, including the Grind 75, Grind 169, and the original Blind 75. This argument is an optional argument instead of inputting urls or a file of questions. 

README.md

@@ -5,12 +5,7 @@
 [![PyPi](https://img.shields.io/pypi/v/leetcode-study-tool)](https://pypi.org/project/leetcode-study-tool/)
 ![contributions welcome](https://img.shields.io/badge/contributions-welcome-blue.svg?style=flat)
 
-This package lets you get grokking as quickly as possible with Leetcode. It provides a command-line tool for interracting with Leetcode to create flashcards for study,
-which can then be imported into Anki. Currently, this tool supports taking in a list of  or popular study sets (including the [Blind 75](https://www.teamblind.com/post/New-Year-Gift---Curated-List-of-Top-75-LeetCode-Questions-to-Save-Your-Time-OaM1orEU), [Grind 75](https://www.techinterviewhandbook.org/grind75), and [Neetcode 150](https://neetcode.io/practice)) and outputting 
-problems in a format that can be imported to Anki. These cards include three fields:
-1. The front of the study card, containing the question ID, Title, URL, and problem description 
-2. The publicly available solutions (and NeetCode solution, if available)
-3. The tags associated with the problem (i.e., if the problem involves a hash map, arrays, etc...)
+This package lets you get grokking as quickly as possible with Leetcode. It provides a command-line tool for interracting with Leetcode to create either an Excel file or Anki flashcards for study. Currently, this tool supports taking in a list of leetcode question slugs or URLs or popular study sets (including the [Blind 75](https://www.teamblind.com/post/New-Year-Gift---Curated-List-of-Top-75-LeetCode-Questions-to-Save-Your-Time-OaM1orEU), [Grind 75](https://www.techinterviewhandbook.org/grind75), and [Neetcode 150](https://neetcode.io/practice)). 
 
 ## Why? 
 This package was created as an opinionated alternative to other existing packages (as listed at the bottom of this README). 
@@ -24,7 +19,7 @@ $ pip install leetcode-study-tool
 ```shell
 usage: leetcode-study-tool [-h]
                            (--url URL | --file FILE | --preset {blind_75,grind_75,grind_169,neetcode_150,neetcode_all})
-                           [--format {anki}] [--csrf CSRF] [--output OUTPUT]
+                           [--format {anki,excel}] [--csrf CSRF] [--output OUTPUT]
                            [--language LANGUAGE]
 
 Generates problems from LeetCode questions in a desired format.
@@ -33,11 +28,11 @@ options:
   -h, --help            show this help message and exit
   --url URL, -u URL     The URL(s) or slug(s) of the LeetCode question(s) to generate
                         problem(s) for. (default: None)
-  --file FILE, -f FILE  The file containing the URL(s) or slug(s) of the LeetCode
-                        question(s) to generate problem(s) for. (default: None)
+  --file FILE, -f FILE  The file containing the URL(s) or slug(s) of the LeetCode question(s)
+                        to generate problem(s) for. (default: None)
   --preset {blind_75,grind_75,grind_169,neetcode_150,neetcode_all}, -p {blind_75,grind_75,grind_169,neetcode_150,neetcode_all}
                         The preset to use to generate problem(s) for. (default: None)
-  --format {anki}, -F {anki}
+  --format {anki,excel}, -F {anki,excel}
                         The format to save the Leetcode problem(s) in. (default: anki)
   --csrf CSRF, -c CSRF  The CSRF token to use for LeetCode authentication. (default: None)
   --output OUTPUT, -o OUTPUT
@@ -59,16 +54,33 @@ which will generate the file `output.txt`. We can then open Anki to import these
 
 ![anki demo](static/anki-demo.gif)
 
+## Anki
+When generating an Anki output, the resulting "cards" are saved as a `.txt` file. These cards include three fields:
+1. The front of the study card, containing the question ID, Title, URL, and problem description 
+2. The publicly available solutions (and NeetCode solution, if available)
+3. The tags associated with the problem (i.e., if the problem involves a hash map, arrays, etc...)
+
+## Excel
+When generating an Excel output, the resulting questions are saved in an `.xlsx` file. Each problem includes the following fields:
+1. ID of the leetcode question
+2. Title of the leetcode question
+3. URL of the leetcode question
+4. Last date that this question was attempted by the user (please note that this is not pulled from your leetcode profile, but left for you to update as you progress in solving leetcode questions)
+5. The tags associated with the problem (i.e., if the problem involves a hash map, arrays, etc...)
+6. Neetcode video link (if it exists)
+7. Solution links for the problem (if they are reachable)
+8. Companies that have asked this question recently in interviews (if they are reachable)
 
 ## Roadmap 
+- [X] Use TQDM to show card generation progress
+- [X] Add support for exporting to an excel sheet
+- [X] Add support for showing neetcode solutions on the back of the card as a 
+- [ ] Add support for getting the difficulty of questions 
 - [ ] Add support for fetching premium questions via authentification
 - [ ] Add support for importing cards into Quizlet
 - [ ] Add support for fetching questions by topic or tag 
-- [ ] Add support for exporting to an excel sheet
-- [X] Add support for showing neetcode solutions on the back of the card as a link
-- [ ] Add support for determining which fields to show on the card 
-- [ ] Use TQDM to show card generation progress
-- [ ] Allow for the definition of custom formatters and outputs
+link
+- [ ] Allow for the definition of custom formatters and outputs (including which fields are included or excluded)
 - [ ] Reach 90% test coverage
 
 ## Other Usefull Stuff

leetcode_study_tool/cli.py

@@ -55,7 +55,7 @@ def generate_parser() -> argparse.ArgumentParser:
         "-F",
         type=str,
         default="anki",
-        choices=["anki"],
+        choices=["anki", "excel"],
         help="The format to save the Leetcode problem(s) in.",
     )
 

leetcode_study_tool/creator.py

@@ -2,9 +2,11 @@
 import html
 import os
 import re
-from multiprocessing import Pool
+from datetime import date
 from typing import List, Union
 
+from p_tqdm import p_map
+
 from .constants.presets import PRESET_MAP
 from .formatters import FORMAT_MAP
 from .outputs import SAVE_MAP
@@ -49,11 +51,13 @@ def create_problems(self) -> None:
         """
         Create the problems for Anki.
         """
-        with Pool() as pool:
-            problems = pool.map(
-                self._generate_problem,
-                self.urls,
-            )
+        problems = p_map(self._generate_problem, self.urls)
+
+        # with Pool() as pool:
+        #     problems = pool.map(
+        #         self._generate_problem,
+        #         self.urls,
+        #     )
 
         self._save_output(problems, self.output)
 
@@ -83,10 +87,12 @@ def _sanitize(self, input: Union[str, list, None]) -> Union[str, list]:
         input = re.sub(r"(<br>){2,}", "<br>", input)
         return input
 
-    def _save_output(self, problems: List[Union[str, None]], file: str) -> None:
+    def _save_output(
+        self, problems: List[Union[List[Union[str, date]], None]], file: str
+    ) -> None:
         file_name = os.path.splitext(os.path.basename(file))[0]
 
-        SAVE_MAP[self.format](problems, file_name)
+        SAVE_MAP[self.format](problems, file_name)  # type: ignore
 
     def _generate_problem(self, url: str) -> Union[str, None]:
         """

leetcode_study_tool/formatters.py

@@ -1,5 +1,6 @@
+from datetime import date
 from textwrap import dedent
-from typing import List
+from typing import List, Union
 
 from leetcode_study_tool.constants.leetcode_to_neetcode import (
     LEETCODE_TO_NEETCODE,  # fmt: skip
@@ -11,7 +12,7 @@ def format_list_element(
     title: str, elements: List[str], is_link: bool = False
 ) -> str:
     """
-    formats a list element for the given title and elements
+    formats an HTML list element for the given title and elements
 
     Arguments
     ---------
@@ -141,7 +142,7 @@ def format_quizlet(url: str, slug: str, data: dict):
     pass
 
 
-def format_excel(url: str, slug: str, data: dict):
+def format_excel(url: str, slug: str, data: dict) -> List[Union[str, date]]:
     """
     formats an Excel problem for the given URL and data
 
@@ -157,9 +158,37 @@ def format_excel(url: str, slug: str, data: dict):
     Returns
     -------
     str
-        The Excel problem for the given URL and data.
+        The Excel problem for the given URL and data. The problem
+        is formatted as a list of strings, where each string is a
+        column in the Excel file. This row will have the ordering:
+        [id, title, url, date attempted, tags, neetcode, solutions, companies]
     """
-    pass
+    row = []
+    row.append(data["id"])
+    row.append(data["title"])
+    row.append(get_url(url))
+    row.append(date.today())
+    row.append(", ".join([tag["name"] for tag in data["tags"]]))
+    if str(data["id"]) in LEETCODE_TO_NEETCODE:
+        neetcode = LEETCODE_TO_NEETCODE[str(data["id"])]
+        row.append(neetcode["url"])
+    else:
+        row.append("")
+    row.append(
+        "\n".join(
+            [
+                format_solution_link(slug, solution["id"])
+                for solution in data["solutions"]
+            ]
+        )
+    )
+    if data.get("companies"):
+        row.append(
+            ", ".join([company["name"] for company in data["companies"]])
+        )
+    else:
+        row.append("")
+    return row
 
 
 FORMAT_MAP = {

leetcode_study_tool/outputs.py

@@ -1,5 +1,9 @@
+import os
+from datetime import date
 from typing import List, Union
 
+import xlsxwriter
+
 
 def save_string(problems: List[Union[str, None]], file: str) -> None:
     """
@@ -18,18 +22,66 @@ def save_string(problems: List[Union[str, None]], file: str) -> None:
                 f.write(problem + "\n")
 
 
-def save_excel(problems: List[Union[str, None]], file: str) -> None:
+def save_excel(
+    problems: List[Union[List[Union[str, date]], None]], file: str
+) -> None:
     """
     Save the given problems to the given Excel file.
 
     Arguments
     ---------
-    problems : List[Union[str, None]]
+    problems : List[Union[List[str], None]]
         The problems to save.
     file : str
         The file to save the problems to.
     """
-    pass
+    if os.path.exists(file + ".xlsx"):
+        os.remove(file + ".xlsx")
+    workbook = xlsxwriter.Workbook(file + ".xlsx")
+    worksheet = workbook.add_worksheet()
+
+    worksheet.write(0, 0, "ID")
+    worksheet.write(0, 1, "Title")
+    worksheet.write(
+        0,
+        2,
+        "Url",
+    )
+    worksheet.write(0, 3, "Date Attempted")
+    worksheet.write(0, 4, "Tags")
+    worksheet.write(0, 5, "Neetcode")
+    worksheet.write(0, 6, "Solutions")
+    worksheet.write(0, 7, "Companies")
+
+    # Add bold formatting to the first row
+    bold = workbook.add_format({"bold": True})
+    worksheet.set_row(0, None, bold)
+
+    # Add gradient formatting to the date attempted row
+    worksheet.conditional_format(
+        1,
+        3,
+        len(problems),
+        3,
+        {
+            "type": "3_color_scale",
+            "min_color": "red",
+            "mid_color": "yellow",
+            "max_color": "green",
+        },
+    )
+
+    date_format = workbook.add_format({"num_format": "dd/mm/yy"})
+
+    for i, problem in enumerate(problems, start=1):
+        if problem:
+            for j, line in enumerate(problem):
+                if type(line) == date and j == 3:
+                    worksheet.write_datetime(i, j, line, date_format)
+                else:
+                    worksheet.write(i, j, line)
+
+    workbook.close()
 
 
 SAVE_MAP = {

pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "leetcode-study-tool"
-version = "1.1.0"
+version = "1.2.0"
 description = "A tool for studying Leetcode with Python"
 authors = [{name="John Sutor", email="johnsutor3@gmail.com" }]
 license = {file = "LICENSE.txt"}
 readme = "README.md"
-dependencies = ["requests"]
+dependencies = ["requests", "XlsxWriter", "p_tqdm"]
 keywords = ["leetcode", "leet", "study", "Anki"]
 classifiers=[
             # Development status

requirements.txt

@@ -1,4 +1,6 @@
 setuptools==68.0.0
 wheel==0.38.4
 requests==2.31.0
-types-requests==2.31
+types-requests==2.31
+xlsxwriter==3.1.2
+p_tqdm==1.4.0

tests/test_formatters.py

@@ -39,3 +39,21 @@ def test_format_anki(self):
             formatters.format_anki(get_url("two-sum"), "two-sum", data),
             self.correct_anki_formatted_two_sum_problem,
         )
+
+    def test_format_excel(self):
+        data = get_data("two-sum")
+        # Don't check the last two elements of the list because they
+        # will change over time. Also, mocking time causes issues with
+        # urllib, so avoid.
+        output = formatters.format_excel(get_url("two-sum"), "two-sum", data)
+        output = output[:3] + output[4:-2]
+        self.assertListEqual(
+            output,
+            [
+                "1",
+                "Two Sum",
+                "https://leetcode.com/problems/two-sum/",
+                "Array, Hash Table",
+                "https://youtube.com/watch?v=KLlXCFG5TnA",
+            ],
+        )