opgg.py 3.1.0

An unofficial Python library for scraping/accessing data from OP.GG

OPGG.py

An unofficial Python library for accessing OPGG data.

Prerequisites

• Python 3.12+

Note: Will likely work on versions slightly older or newer

Installation

Automatic

This library is available as a pip package and can be installed via the following command:

py -m pip install opgg.py

Manual

Dependencies

• aiohttp
• pydantic
• fake-useragent

Alternatively, you can use the provided requirements.txt to install the required libraries by running the following command:

py -m pip install -r requirements.txt

Usage / Basic Example

Importing the library

from opgg.opgg import OPGG
from opgg.params import Region


def main():
    opgg = OPGG()

    results = opgg.search("HandOfTheCouncil", Region.NA)
    [print(result) for result in results]


if __name__ == "__main__":
    main()

Output

Important Note: The information returned below is a summary view with the most important parts of each object shown "at a glance". Many of the objects have several additional properties that can be accessed by referencing the object in code.

[NA  ] HandoftheCouncil #NA1     | Level: 556  [Summoner ID: t7NuBl5eATWiqoZMu2MzZbAX1S9IDyp4Kzut5Z_4QT3-tWs]

Development

Setting Up Development Environment

Step 1. Clone the repository:

git clone https://github.com/ShoobyDoo/OPGG.py.git
cd OPGG.py

Step 2. Install production dependencies:

pip install -r requirements.txt

Code Quality

Run linting with ruff:

ruff check opgg/

Auto-fix linting issues:

ruff check --fix opgg/

Check code formatting:

ruff format --check opgg/

Auto-format code:

ruff format opgg/

Ensure code formatting is run prior to opening a pull request.

Join the Discussion

Here's a link to the Support Discord