Update readme and workflow

Author: johnsutor

.github/workflows/python-app.yml

@@ -1,7 +1,4 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
-name: Test and Lint 
+name: Tests
 
 on:
   push:
@@ -14,11 +11,11 @@ permissions:
 
 jobs:
   build:
-
-    runs-on: [ubuntu-latest, windows-latest, macos-latest]
     strategy:
       matrix:
-        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"]
+        os: ['ubuntu-latest', 'windows-latest', 'macos-latest']
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+    runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -28,7 +25,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install -r requirements.txt
     - name: Lint with ruff
       run: |
         pip install ruff 
@@ -40,12 +37,12 @@ jobs:
     - name: Test with pytest
       run: |
         pip install pytest pytest-cov
-        pytest tests.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+        pytest tests/ --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
     - name: Examine formatting with black 
       run: |
         pip install black
-        black . --preview --check
+        black . --check
     - name: Examine import ordering with isort 
       run: |
         pip install isort
-        isort . --check 
+        isort . --check --profile black

README.md

@@ -1,8 +1,20 @@
 # Leetcode Study Tool
-[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dwyl/esta/issues)
+![Tests Status](https://github.com/johnsutor/leetcode-study-tool/workflows/Tests/badge.svg)
+[![Python Versions](https://img.shields.io/pypi/pyversions/leetcode-study-tool)](https://pypi.org/project/leetcode-study-tool/)
+[![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 provides a command-line tool for interracting with Leetcode to create flashcards for study,
-which can then be imported into Anki.
+which can then be imported into Anki. Currently, this tool supports taking in a list of URLs 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...)
+
+## Installation
+```shell
+$ pip install leetcode-study-tool
+```
 
 ## Usage 
 ```shell
@@ -22,6 +34,16 @@ options:
                         The language to generate problem(s) for. (default: None)
 ```
 
+## Example 
+In a directory with a file named `questions.txt`, where each line is either a Leetcode problem URL or slug (or a combination of both), we can run the command 
+```shell
+$ leetcode-study-tool -f questions.txt 
+```
+which will generate the file `output.txt`. We can then open Anki to import these problems as demonstrated below, *ensuring to select semicolon as a field separator*.
+
+![anki demo](static/anki-demo.gif)
+
+
 ## Roadmap 
 - [ ] Add support for fetching premium questions via authentification
 - [ ] Add support for importing cards into Quizlet

leetcode_study_tool/cli.py

@@ -3,13 +3,13 @@
 import re
 from functools import partial
 from multiprocessing import Pool
-from typing import List
+from typing import List, Union
 
 from .constants.leetcode_to_neetcode import LEETCODE_TO_NEETCODE
 from .queries import get_data, get_slug, get_url
 
 
-def sanitize(input: str | list | None) -> str | list:
+def sanitize(input: Union[str, list, None]) -> Union[str, list]:
     """
     Sanitize the given input to be Anki-compatible. This includes
     removing delimeters with the desired Anki delimeter chosen
@@ -56,7 +56,7 @@ def generate_solution_link(slug: str, solution_id: str) -> str:
 
 
 def save_output(
-    problems: List[str | None], file: str, format: str = "cards"
+    problems: List[Union[str, None]], file: str, format: str = "cards"
 ) -> None:
     with open(file, "w") as f:
         for problem in problems:
@@ -65,8 +65,8 @@ def save_output(
 
 
 def generate_problem(
-    url: str, language: str | None = None, format: str = "cards"
-) -> str | None:
+    url: str, language: Union[str, None] = None, format: str = "cards"
+) -> Union[str, None]:
     """
     Generates a problem strings for the given URL in the requested format
 
@@ -112,9 +112,7 @@ def generate_problem(
     if str(data["id"]) in LEETCODE_TO_NEETCODE:
         neetcode = LEETCODE_TO_NEETCODE[str(data["id"])]
         problem += "<strong>NeetCode Solution:</strong><br>"
-        problem += (
-            f"<a href=\"{neetcode['url']}\">{neetcode['title']}</a></li><br><br>"
-        )
+        problem += f"<a href=\"{neetcode['url']}\">{neetcode['title']}</a></li><br><br>"
 
     problem += "<strong>LeetCode User Solutions:</strong><br>"
 

leetcode_study_tool/queries.py

@@ -1,13 +1,19 @@
 import json
 import re
-from functools import cache
+from functools import lru_cache
+from typing import Union
 from urllib.parse import urlparse
 
 import requests
 
-from .constants.graphql import (BASE_URL, COMMUNITY_SOLUTIONS,
-                                QUESTION_CONTENT, QUESTION_DETAIL_COMPANY_TAGS,
-                                QUESTION_TITLE, SINGLE_QUESTION_TOPIC_TAGS)
+from .constants.graphql import (
+    BASE_URL,
+    COMMUNITY_SOLUTIONS,
+    QUESTION_CONTENT,
+    QUESTION_DETAIL_COMPANY_TAGS,
+    QUESTION_TITLE,
+    SINGLE_QUESTION_TOPIC_TAGS,
+)
 
 MAPPINGS = {
     "content": QUESTION_CONTENT,
@@ -77,7 +83,7 @@ def get_url(input: str, type: str = "problem") -> str:
         return f"https://leetcode.com/tag/{input}/"
 
 
-@cache
+@lru_cache(maxsize=None)
 def query(content: str, slug: str, **kwargs) -> dict:
     """
     Query the LeetCode GraphQL API for the given content.
@@ -117,7 +123,7 @@ def query(content: str, slug: str, **kwargs) -> dict:
         )
 
 
-def get_data(slug: str, language: str | None = None) -> dict:
+def get_data(slug: str, language: Union[str, None] = None) -> dict:
     """
     Get the relevant data for constructing the Anki card for the given URL.
 

pyproject.toml

@@ -4,17 +4,40 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "leetcode-study-tool"
-version = "1.0.0"
+version = "1.0.1"
 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"]
 keywords = ["leetcode", "leet", "study", "Anki"]
+classifiers=[
+            # Development status
+            'Development Status :: 4 - Beta',
+
+            # Supported OS
+            'Operating System :: Microsoft :: Windows',
+            'Operating System :: MacOS',
+            'Operating System :: POSIX :: Linux',
+
+            # Supported Python versions
+            'Programming Language :: Python :: 3.7',
+            'Programming Language :: Python :: 3.8',
+            'Programming Language :: Python :: 3.9',
+            'Programming Language :: Python :: 3.10',
+            'Programming Language :: Python :: 3.11',
+
+            # License
+            'License :: OSI Approved :: MIT License',
+
+            # Topic
+            'Topic :: Software Development',
+            'Topic :: Education',
+        ]
 
 [tool.black]
 line-length = 80
-target-version = ["py38", "py39", "py310", "py311"]
+target-version = ["py37", "py38", "py39", "py310", "py311"]
 
 [options]
 python_requires = ">=3.6"
@@ -31,5 +54,8 @@ exclude = [
 ]
 ignore_missing_imports = true
 
+[tool.setuptools.packages.find]
+include = ["leetcode_study_tool"]  
+
 # [project.optional_dependencies]
 # scripts = ["google-api-python-client", "google-auth-oauthlib", "google-auth-httplib2"]

requirements.txt

@@ -1,3 +1,4 @@
-setuptools=68.0.0
-wheel=0.38.4
-requests=2.31.0
+setuptools==68.0.0
+wheel==0.38.4
+requests==2.31.0
+types-requests==2.31

scripts/neetcode.py

@@ -9,14 +9,15 @@
 import os
 import re
 import sys
+from typing import Union
 
 import googleapiclient.discovery
 import googleapiclient.errors
 
 scopes = ["https://www.googleapis.com/auth/youtube.readonly"]
 
 
-def main(youtube_api_key: str | None = None):
+def main(youtube_api_key: Union[str, None] = None):
     # Disable OAuthlib's HTTPS verification when running locally.
     # *DO NOT* leave this option enabled in production.
     os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "1"