Skip to content

Commit 7c1bb26

Browse files
committed
Better README. Removed not related information
1 parent a40c24a commit 7c1bb26

File tree

2 files changed

+4
-24
lines changed

2 files changed

+4
-24
lines changed

README.md

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,10 @@
1-
# Leetcode API implementation.
2-
31
![build](https://app.travis-ci.com/prius/python-leetcode.svg?branch=main)
42

5-
This implements methods that are available publicly for leetcode.
6-
There is already an implementation of them in form of CLI [1], but
7-
it has a list of disadvantages.
8-
9-
10-
1. It is written in JS
11-
12-
2. Even for JS in order to reuse it you have to invoke it via CLI
13-
14-
3. It is not supported very well, so authentication doesn't work anymore
15-
16-
17-
So I have decided to create my own implementation and here is it.
18-
19-
20-
Using the swagger file you'll be able to generate the code for any language
21-
you like and start using leetcode API directly from your code.
3+
# Leetcode API implementation
224

5+
This repo contains a python client to access all known so far methods of Leetcode API.
236

24-
Just keep in mind that swagger doesn't really support cookie auth,
25-
which is needed in order to use LC API. If you use python you can
26-
just use the generated code from this repo. Otherwise you'll have to
27-
implement something like `fix_cookies.patch` for your target language.
7+
The code is autogenerated by swagger. Swagger reference can be found here: [https://github.com/prius/leetcode-swagger](https://github.com/prius/leetcode-swagger)
288

299
## Minimal working example
3010

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
from setuptools import find_packages, setup # noqa: H301
1313

1414
NAME = "python-leetcode"
15-
VERSION = "1.0.1"
15+
VERSION = "1.0.2"
1616

1717
with open("README.md") as readme:
1818
DESCRIPTION = readme.read()

0 commit comments

Comments
 (0)