Jinja and Code Solutions (#1)

* Add jinja and code solutions
* Fix formatters

Author: johnsutor

.DS_Store

@@ -1,4 +1,7 @@
 # Changelog 
+## 1.3.5
+- Add Jinja templates in favor over standard library for string formatting 
+- Add problems pulled from Neetcode solutions GitHub
 
 ## 1.3.4
 - Add Neetcode 250 

CHANGELOG.md

@@ -0,0 +1 @@
+recursive-include leetcode_study_tool/templates *

MANIFEST.in

@@ -10,10 +10,11 @@ all:
 
 format:
 	python -m ruff format ./leetcode_study_tool
+	python -m ruff check ./leetcode_study_tool --fix
 
 format-check:
-	python -m ruff check ./leetcode_study_tool 
 	python -m ruff format ./leetcode_study_tool --check
+	python -m ruff check ./leetcode_study_tool 
 
 test:
 	pytest tests/ --cov --cov-fail-under=85

Makefile

@@ -20,7 +20,7 @@ $ pip install leetcode-study-tool
 ## 💻 Usage 
 ```shell
 usage: leetcode-study-tool [-h] (--url URL | --file FILE | --preset {blind_75,grind_75,grind_169,neetcode_150,neetcode_250,neetcode_all}) [--format {anki,excel}]
-                           [--csrf CSRF] [--output OUTPUT] [--language LANGUAGE]
+                           [--template TEMPLATE] [--csrf CSRF] [--output OUTPUT] [--language LANGUAGE] [--include-code]
 
 Generates problems from LeetCode questions in a desired format.
 
@@ -32,11 +32,14 @@ options:
                         The preset to use to generate problem(s) for. (default: None)
   --format {anki,excel}, -F {anki,excel}
                         The format to save the Leetcode problem(s) in. (default: anki)
+  --template TEMPLATE, -t TEMPLATE
+                        Path to a custom Jinja template file for rendering problems. (default: None)
   --csrf CSRF, -c CSRF  The CSRF token to use for LeetCode authentication. (default: None)
   --output OUTPUT, -o OUTPUT
                         The output file to write the problem(s) to. (default: output.txt)
   --language LANGUAGE, -l LANGUAGE
                         The language to generate problem(s) for. (default: None)
+  --include-code, -ic   Include solution code from NeetCode GitHub repository using the specified language. (default: False)
 ```
 
 ## 💡 Example 
@@ -52,10 +55,22 @@ which will generate the file `output.txt`. We can then open Anki to import these
 
 ![anki demo](static/anki-demo.gif)
 
+### Including Solution Code
+
+You can include solution code from the NeetCode GitHub repository by using the `--include-code` flag along with specifying a programming language:
+
+```shell
+$ leetcode-study-tool -p grind_75 --language python --include-code
+```
+
+This will fetch solution code in the specified language (when available) and include it in your Anki cards or Excel output.
+
+Supported languages include: c, cpp, csharp, dart, go, java, javascript, kotlin, python, ruby, rust, scala, swift, and typescript.
+
 ## 📒 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)
+2. The publicly available solutions (and NeetCode solution or code, if available)
 3. The tags associated with the problem (i.e., if the problem involves a hash map, arrays, etc...)
 
 ## 📊 Excel
@@ -69,12 +84,83 @@ When generating an Excel output, the resulting questions are saved in an `.xlsx`
 7. Solution links for the problem (if they are reachable)
 8. Companies that have asked this question recently in interviews (if they are reachable)
 
+## Custom Templates
+
+LeetCode Study Tool supports custom Jinja2 templates for generating Anki cards or other outputs. You can specify your own template file using the `--template` flag:
+
+```bash
+leetcode-study-tool --url "https://leetcode.com/problems/two-sum/" --template "path/to/my_template.jinja"
+```
+
+### Template Variables
+
+When creating your custom template, the following variables are available:
+
+| Variable | Description |
+|----------|-------------|
+| `url` | The URL to the LeetCode problem |
+| `slug` | The problem slug |
+| `data` | Object containing all problem data |
+| `data.id` | Problem ID |
+| `data.title` | Problem title |
+| `data.content` | Problem description (HTML) |
+| `data.difficulty` | Problem difficulty (Easy, Medium, Hard) |
+| `data.tags` | List of topic tags for the problem |
+| `data.companies` | List of companies that ask this problem |
+| `data.solutions` | List of available solutions on LeetCode |
+| `data.neetcode_solution` | NeetCode solution code (if --include-code is used) |
+| `data.language` | Language of the solution code |
+| `neetcode` | NeetCode video information (when available) |
+
+### Solution Code Example
+
+Here's an example template that highlights the solution code:
+
+```jinja
+<h1>{{ data.id }}. {{ data.title }} ({{ data.difficulty }})</h1>
+
+<div class="content">
+  {{ data.content }}
+</div>
+
+<div class="tags">
+  {% for tag in data.tags %}
+    <span class="tag">{{ tag.name }}</span>
+  {% endfor %}
+</div>
+
+;
+
+{% if data.neetcode_solution %}
+<h3>Solution Code ({{ data.language }})</h3>
+<pre><code>
+{{ data.neetcode_solution }}
+</code></pre>
+{% endif %}
+
+{% if data.solutions %}
+<div class="community-solutions">
+  <h3>Community Solutions:</h3>
+  <ul>
+    {% for solution in data.solutions[:3] %}
+      <li><a href="{{ solution_url(slug, solution.id) }}">Solution {{ loop.index }}</a></li>
+    {% endfor %}
+  </ul>
+</div>
+{% endif %}
+
+;
+
+{{ data.tags|map(attribute='slug')|join(' ') }}
+```
+
 ## 🛣 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 
 - [X] Add support for getting the difficulty of questions 
-- [ ] Add support for Jinja templating formatters 
+- [X] Add support for Jinja templating formatters 
+- [X] Add support for including NeetCode solution code
 - [ ] Add NeetCode shorts 
 - [ ] Add support for fetching premium questions via authentification
 - [ ] Add support for importing cards into Quizlet

README.md

@@ -57,6 +57,13 @@ def generate_parser() -> argparse.ArgumentParser:
         help="The format to save the Leetcode problem(s) in.",
     )
 
+    parser.add_argument(
+        "--template",
+        "-t",
+        type=str,
+        help="Path to a custom Jinja template file for rendering problems.",
+    )
+
     parser.add_argument(
         "--csrf",
         "-c",
@@ -77,6 +84,14 @@ def generate_parser() -> argparse.ArgumentParser:
         "-l",
         type=str,
         help="The language to generate problem(s) for.",
+        default="python",
+    )
+
+    parser.add_argument(
+        "--include-code",
+        "-ic",
+        action="store_true",
+        help="Include solution code from NeetCode GitHub repository using the specified language.",
     )
 
     return parser

leetcode_study_tool/cli.py

@@ -10,7 +10,12 @@
 from leetcode_study_tool.formatters import FORMAT_MAP
 from leetcode_study_tool.outputs import SAVE_MAP
 from leetcode_study_tool.presets import PRESET_MAP
-from leetcode_study_tool.queries import generate_session, get_data, get_slug
+from leetcode_study_tool.queries import (
+    generate_session,
+    get_data,
+    get_neetcode_solution,
+    get_slug,
+)
 
 
 class ProblemsCreator:
@@ -19,9 +24,10 @@ class ProblemsCreator:
     """
 
     def __init__(self, args: Union[argparse.Namespace, dict]) -> None:
-        # Explicitly define for linting
         self.format = "anki"
         self.output = "output"
+        self.template = None
+        self.include_code = False
 
         args = vars(args)
         for key in args:
@@ -53,12 +59,6 @@ def create_problems(self) -> None:
         """
         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)
 
     def _sanitize(self, input: Union[str, list, None]) -> Union[str, list]:
@@ -82,8 +82,6 @@ def _sanitize(self, input: Union[str, list, None]) -> Union[str, list]:
         if isinstance(input, list):
             return input
         input = html.unescape(input)
-        # input = input.replace(";", " ")
-        # input = input.replace("\n", " ")
         input = re.sub(r"[;\n\r]", " ", input)
         input = input.replace("</strong>", "</strong><br>")
         input = re.sub(r"(<br>){2,}", "<br>", input)
@@ -104,8 +102,6 @@ def _generate_problem(self, url: str) -> Union[str, None]:
         ---------
         url : str
             The URL of the question to generate a problem for.
-        language : str
-            The coding language to generate a problem for.
 
         Returns
         -------
@@ -118,10 +114,25 @@ def _generate_problem(self, url: str) -> Union[str, None]:
         slug = get_slug(url)
         try:
             data = get_data(slug, self.language, self.session)
+
+            if (
+                self.include_code
+                and self.language
+                and not data.get("neetcode_solution")
+            ):
+                github_solution = get_neetcode_solution(
+                    data["id"], data["title"], self.language
+                )
+                if github_solution:
+                    data["neetcode_solution"] = github_solution
+
         except Exception as e:
             print(f"Failed to generate problem for {url}: {e}")
             return None
 
         data = {k: self._sanitize(v) for k, v in data.items()}
 
-        return FORMAT_MAP[self.format](url, slug, data)  # type: ignore
+        if self.format == "anki":
+            return FORMAT_MAP[self.format](url, slug, data, self.template)  # type: ignore
+        else:
+            return FORMAT_MAP[self.format](url, slug, data)  # type: ignore