Add development dependencies for testing and formatting

Change inputs to work properly

Author: johnsutor

.github/workflows/check-style.yml

@@ -28,7 +28,7 @@ jobs:
     - name: Examine formatting with black 
       run: |
         pip install black
-        black . --check
+        ruff . --check
     - name: Examine import ordering with isort 
       run: |
         pip install isort

.github/workflows/run-tests.yml

@@ -36,7 +36,7 @@ jobs:
         mypy . --ignore-missing-imports --exclude /build/
     - name: Install package
       run: |
-        pip install -e .
+        pip install -e ".[dev]"
     - name: Test with pytest, ensuring 75% coverage
       run: |
         pip install pytest pytest-cov

Makefile

@@ -0,0 +1,23 @@
+all:	
+	@echo "Running make format"
+	$(MAKE) format
+	@echo "Running make format-check"
+	$(MAKE) format-check
+	@echo "Running make test"
+	$(MAKE) test
+	@echo "Running make type-check"
+	$(MAKE) type-check
+
+format:
+	ruff format .
+	isort --profile black .
+
+format-check:
+	ruff check .
+	isort --check-only --profile black .
+
+test:
+	pytest tests/ --cov --cov-fail-under=85
+
+type-check:
+	mypy src

leetcode_study_tool/cli.py

@@ -1,7 +1,7 @@
 import argparse
 
-from leetcode_study_tool.constants.presets import PRESET_MAP
 from leetcode_study_tool.creator import ProblemsCreator
+from leetcode_study_tool.presets import PRESET_MAP
 
 
 def generate_parser() -> argparse.ArgumentParser:
@@ -14,9 +14,7 @@ def generate_parser() -> argparse.ArgumentParser:
         The parsed command line arguments.
     """
     parser = argparse.ArgumentParser(
-        description=(
-            "Generates problems from LeetCode questions in a desired format."
-        ),
+        description=("Generates problems from LeetCode questions in a desired format."),
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
 

leetcode_study_tool/creator.py

@@ -7,9 +7,9 @@
 
 from p_tqdm import p_map
 
-from leetcode_study_tool.constants.presets import PRESET_MAP
 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
 
 

leetcode_study_tool/formatters.py

@@ -2,15 +2,11 @@
 from textwrap import dedent
 from typing import List, Union
 
-from leetcode_study_tool.constants.leetcode_to_neetcode import (
-    LEETCODE_TO_NEETCODE,  # fmt: skip
-)
+from leetcode_study_tool.leetcode_to_neetcode import LEETCODE_TO_NEETCODE  # fmt: skip
 from leetcode_study_tool.queries import get_url
 
 
-def format_list_element(
-    title: str, elements: List[str], is_link: bool = False
-) -> str:
+def format_list_element(title: str, elements: List[str], is_link: bool = False) -> str:
     """
     formats an HTML list element for the given title and elements
 
@@ -92,9 +88,7 @@ def format_anki(url: str, slug: str, data: dict):
         )
 
     if data["tags"]:
-        problem += format_list_element(
-            "Tags", [tag["name"] for tag in data["tags"]]
-        )
+        problem += format_list_element("Tags", [tag["name"] for tag in data["tags"]])
 
     problem += ";"
 
@@ -184,9 +178,7 @@ def format_excel(url: str, slug: str, data: dict) -> List[Union[str, date]]:
         )
     )
     if data.get("companies"):
-        row.append(
-            ", ".join([company["name"] for company in data["companies"]])
-        )
+        row.append(", ".join([company["name"] for company in data["companies"]]))
     else:
         row.append("")
     return row