Easy-to-use wrapper for the League Client API.
Project description
LCU Connector
This library serves to make the connection with the League Client API in a simple way, although there are others, such as lcu-driver (which by the way is very good), but with lcu-driver, for example, I couldn't work and structure my code the way I wanted it to, so I decided to make my own wrapper.
Quick start
I will be brief in the explanation but I guarantee that it will be enough, as this library is simple to use. Among other things, I'm working on more elaborate documentation.
So, hand in the dough! Or rather, on the keyboard...
Installation
Just use pip and it's fine.
pip install lcu-connector
How to use
Import the Connector
from the lcu_connector
module, instantiate it and start the session via the .start()
method or passing the start=True
parameter directly in the instance.
from lcu_connector import Connector
# Method 01
conn = Connector(start=True)
# Method 02
conn = Connector()
conn.start()
Now have fun, the Connector
object has the same attributes as the requests
library and derivatives.
from lcu_connector import Connector
conn = Connector(start=True)
# Getting the data of the currently connected summoner
res = conn.get('/lol-summoner/v1/current-summoner')
print(res.json())
# Getting a summoner's data by name
summoner_name = 'JohnDoe'
res = conn.get('/lol-summoner/v1/summoners?name={summoner_name}')
print(res.json())
# Performing POST request
data = {
'foo': 'bar'
}
res = conn.post('API_URL', data=data)
if res.status_code == 200:
do_something()
conn.stop()
You can see all available links for League Client through LCU Explorer.
To-do
- API event watcher
- Built-in functions for commonly used tasks (like a get_summoner_by_name())
- More detailed documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file lcu-connector-1.0.2.tar.gz
.
File metadata
- Download URL: lcu-connector-1.0.2.tar.gz
- Upload date:
- Size: 7.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45475ea55b6a2e3a92968601353353455f5d12beeef29317d4bd68138f68ac2b |
|
MD5 | 4cd5cb6d9d44d9369d671fd979877372 |
|
BLAKE2b-256 | cd6be59b149b0e177f7667fd4a55e5fa22c48d78999d32ac089bc635a700cfc6 |
File details
Details for the file lcu_connector-1.0.2-py3-none-any.whl
.
File metadata
- Download URL: lcu_connector-1.0.2-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 764b94f8b2b8f981e48c8e568b294bab11983e54b9228c38885c1eee567524f2 |
|
MD5 | 9f8fbe660a3933a0ec3049e1e8370ed0 |
|
BLAKE2b-256 | cac7cbd4906599ae0a6795072acdcc79afe3be252f713f73fb84a58c07297ee0 |