Skip to content

fp12/achallonge

Repository files navigation

achallonge

async Challonge for Python 3.5+

Build Status Documentation Status Coverage Status

Modern library that is more than just a wrapper for the Challonge web API

Requirements

  • aiohttp

Optional:

  • cchardet faster replacement for chardet, as mentionned on the aiohttp page
  • aiodns for speeding up DNS resolving, highly recommended by aiohttp

Python version support

  • 3.5
  • 3.6
  • 3.7

Installation

pip install achallonge

If you want to have the optional dependencies for aiohttp, you can:

pip install achallonge[speed]

Usage

import challonge

async def foo():
    # Log in into Challonge with your CHALLONGE! API credentials (https://challonge.com/settings/developer).
    user = await challonge.get_user('your_challonge_username', 'your_api_key')

    # Retrieve your tournaments
    tournaments = await user.get_tournaments()

    # Tournaments, matches, and participants are all represented as Python classes
    for t in tournaments:
        print(t.id)  # 3272
        print(t.name)  # 'My Awesome Tournament'
        print(t.status)  # 'open'

    # Retrieve the participants for a given tournament.
    participants = await tournaments[0].get_participants()
    print(len(participants)) # 13

Documentation

The full documentation can be found on Read the docs

Author / License

Distributed under MIT license. See LICENSE for details

Fabien Poupineau (fp12) - 2017-2019

Twitter: @fp12gaming

Join the Discord Server and discuss about this lib!