Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fbjorn/leetcode-runner
Quick dive into LeetCode problem solving ðŸ§
https://github.com/fbjorn/leetcode-runner
leetcode leetcode-python leetcode-solutions
Last synced: about 2 months ago
JSON representation
Quick dive into LeetCode problem solving ðŸ§
- Host: GitHub
- URL: https://github.com/fbjorn/leetcode-runner
- Owner: fbjorn
- License: mit
- Created: 2021-12-02T12:16:37.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-29T10:39:41.000Z (over 1 year ago)
- Last Synced: 2024-10-13T10:53:40.484Z (3 months ago)
- Topics: leetcode, leetcode-python, leetcode-solutions
- Language: Python
- Homepage:
- Size: 67.4 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Overview
[](https://pypi.org/project/leetcode-runner)
[](https://pypi.org/project/leetcode-runner)
[LeetCode](leetcode.com) is an excellent platform to practice your algorithm solving skills, but coding in their web editor isn't super convenient.
Most likely, you develop solutions in your IDE and run the program several times with different inputs before submitting it, right?
What if you had a CLI utility that would offer:
- Ready-to-run python file with a correct `Solution` placeholder
- Problem description inside the same file
- Built-in Input / Output examples
- Neat test runner
In other words you don't need to copy anything from leetcode. Just a single command and you're ready to rock ðŸ§
Interested? Welcome!
# Installation
Install it directly into an activated virtual environment:
```text
$ pip install leetcode-runner
```
or add it to your [Poetry](https://poetry.eustace.io/) project:
```text
$ poetry add leetcode-runner
```
# Usage
1. Install the library from PyPi
2. Go to [LeetCode](https://leetcode.com) and pick a problem to solve
3. Copy the title slug from the URL (e.g `is-subsequence`) and execute in your terminal:
```shell
leetcode pull is-subsequence
```
It will create a file called `392-is-subsequence.py` and you can start coding straight
away!
```shell
python 392-is-subsequence.py
# or like this, depends on how you manage your python
poetry run python 392-is-subsequence.py
------------------------------
[ FAILED ]
s = "abc", t = "ahbgdc"
Expected: True
Actual : None
------------------------------
[ FAILED ]
s = "axc", t = "ahbgdc"
Expected: False
Actual : None
Passed: 0/2
```
By default a method `Solution` doesn't do anything, that's why the answer is None. You
need to actually solve the problem 😉.
Please read the next section to undestand how it works and also check the
[limitations](#limitations) section.
# Usage (manual)
This is a legacy way to work with this library
1. Install the library from PyPi
2. Go to [LeetCode](https://leetcode.com) and pick a problem to solve
3. Open your favourite IDE and import the `leetcode_runner`
4. Copy problem samples into some variable, like a `problem`, and copy the base
`Solution` class that LeetCode provides
5. `LeetCode(problem, Solution).check()` will run these samples!
6. Pass your own samples into `check` function
```py
from leetcode_runner import LeetCode, TestCase, Args
from typing import *
# Copied as is from the LeetCode
problem = """
Example 1:
Input: nums = [2,7,11,15], target = 9
Output: [0,1]
Output: Because nums[0] + nums[1] == 9, we return [0, 1].
Example 2:
Input: nums = [3,2,4], target = 6
Output: [1,2]
Example 3:
Input: nums = [3,3], target = 6
Output: [0,1]
"""
class Solution:
def twoSum(self, nums: List[int], target: int) -> List[int]:
return [1, 2]
LeetCode(problem, Solution).check()
```
Will print:
```text
------------------------------
[ FAILED ]
nums = [2,7,11,15], target = 9
Expected: [0, 1]
Actual : [1, 2]
------------------------------
[ OK ]
nums = [3,2,4], target = 6
Expected: [1, 2]
Actual : [1, 2]
------------------------------
[ FAILED ]
nums = [3,3], target = 6
Expected: [0, 1]
Actual : [1, 2]
Passed: 1/3
```
Providing custom cases is also possible:
```python
lc = LeetCode(problem, Solution)
lc.check(
extra_cases=[
TestCase(args=Args(nums=[0, 1, 2], target=3), answer=[1, 2]),
# or
TestCase(Args(nums=[0, 1], target=1), [0, 1])
]
)
```
## Code snippet
Just copy & paste this in your IDE and start coding:
```python
from leetcode_runner import LeetCode, TestCase, Args
from typing import *
PROBLEM = """
"""
class Solution:
pass
LeetCode(PROBLEM, Solution).check(
extra_cases=[
]
)
```
# Requirements
- Python 3.9+
# Limitations
- Runner supports python only
- This tool uses Leetcode's GraphQL API under the hood, I'm not sure how long it will be
available for public usage
- This tool can download only public problems. Subscription-based require authentication
that is currently not implemented
---
This project was generated with [cookiecutter](https://github.com/audreyr/cookiecutter)
using [jacebrowning/template-python](https://github.com/jacebrowning/template-python).