Skip to main content

A wrapper for the Steam Leaderboards

Project description

steamleaderboards

A package designed to help developers access the leaderboards of various Steam games.

It was created with the Isaac Daily Run scoreboards in mind, but it can be used for other games as well.

Usage

To use steamleaderboards, first create a LeaderboardGroup for the desired game.

import steamleaderboards as sl
lbgroup = sl.LeaderboardGroup(STEAM_APP_ID)

Once you have created the LeaderboardGroup, you can retrieve the desired leaderboards by using the LeaderboardGroup.get method.
You can specify the name, the display name or the id of the leaderboard to retrieve.

leaderboard_a = lbgroup.get(name=LEADERBOARD_NAME)
leaderboard_b = lbgroup.get(lbid=LEADERBOARD_ID)
leaderboard_c = lbgroup.get(display_name=LEADERBOARD_DISPLAY_NAME)

When you have the Leaderboard object, you can find all the entries in the Leaderboard.entries field, or you can search for a specific one through the Leaderboard.find_entry method.

all_scores = leaderboard_a.entries
my_score = leaderboard_a.find_entry(MY_STEAMID_1)
first_place_score = leaderboard_a.find_entry(rank=1)
last_place_score = leaderboard_a.find_entry(rank=-1)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for steamleaderboards, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size steamleaderboards-0.0.3-py3-none-any.whl (4.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size steamleaderboards-0.0.3.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page