`ramp_database.tools.leaderboard`.get_leaderboard¶

ramp_database.tools.leaderboard.get_leaderboard(session, leaderboard_type, event_name, user_name=None, with_links=True)¶

Get a leaderboard.

Parameters

sessionsqlalchemy.orm.Session: The session to directly perform the operation on the database.
leaderboard_type{‘public’, ‘private’, ‘failed’, ‘new’,: ‘public competition’, ‘private competition’}

The type of leaderboard to generate.
event_namestr: The event name.
user_nameNone or str, default is None: The user name. If None, scores from all users will be queried. This parameter is discarded when requesting the competition leaderboard.
with_linksbool, default is True: Whether or not the submission name should be clickable.

Returns

ramp_database.tools.leaderboard.get_leaderboard¶