Skip to content

Commit 3e50230

Browse files
committed
update readme
1 parent 9974f0b commit 3e50230

1 file changed

Lines changed: 26 additions & 3 deletions

File tree

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,21 @@
77

88
LPDB_python provides Python interfaces for the [Liquipedia Database API](https://liquipedia.net/api) (LPDB API).
99

10-
## LPDB Session
10+
## What You Need
11+
12+
- Python 3.12 or later
13+
- API key for LPDB
14+
- (Optional) [aiohttp](https://github.com/aio-libs/aiohttp)
15+
16+
## Installation
17+
18+
```bash
19+
pip install lpdb_python
20+
```
21+
22+
## Basic Uses
23+
24+
### LPDB Session
1125

1226
Python wrapper for LPDB session is defined in [session.py](src/lpdb_python/session.py). The wrapper provides the following
1327
differences from making your own requests:
@@ -27,7 +41,16 @@ differences from making your own requests:
2741
session = lpdb.LpdbSession("Apikey your_lpdb_api_key")
2842
```
2943

30-
## LPDB Data Types
44+
#### Async Session
45+
46+
Asynchronous implementation of LPDB session can be found in [async_session/session.py](src/lpdb_python/async_session/async_session.py).
47+
This implementation depends on [aiohttp](https://github.com/aio-libs/aiohttp), which can be installed with this library with the following command:
48+
49+
```bash
50+
pip install lpdb_python[async]
51+
```
52+
53+
### LPDB Data Types
3154

3255
Data types in LPDB can be found in <https://liquipedia.net/commons/Help:LiquipediaDB>.
3356

@@ -39,7 +62,7 @@ A property provided by the wrapper may be `None` if the raw data passed to the c
3962
did not contain the data, or if it contained an empty string. Thus, the user should be checking for `None`
4063
where appropriate.
4164

42-
### Example
65+
#### Example
4366

4467
```python
4568
import lpdb_python as lpdb

0 commit comments

Comments
 (0)