Skip to main content

A python library to use the Challonge API

Project description

# achallonge
*async Challonge for Python 3.5+*

[![Build Status](https://travis-ci.org/fp12/achallonge.svg?branch=master)](https://travis-ci.org/fp12/achallonge)
[![Documentation Status](https://readthedocs.org/projects/achallonge/badge/?version=latest)](http://achallonge.readthedocs.io/en/latest/?badge=latest)
[![Coverage Status](https://coveralls.io/repos/github/fp12/achallonge/badge.svg?branch=master)](https://coveralls.io/github/fp12/achallonge?branch=master)
[![Code Issues](https://www.quantifiedcode.com/api/v1/project/cd2c13493bdf461695ada40356a9d3a1/badge.svg)](https://www.quantifiedcode.com/app/project/cd2c13493bdf461695ada40356a9d3a1)


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`

# Installation

pip install achallonge

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

pip install achallonge[speed]

# Usage

```python
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](http://achallonge.readthedocs.io/en/latest/index.html)

# Author / License

Distributed under MIT license. See `LICENSE` for details

Fabien Poupineau (fp12) - 2017

Twitter: [@fp12gaming](https://twitter.com/fp12gaming)

Join the [Discord Server](https://discord.gg/KSRxBav) and discuss about this lib!

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
achallonge-1.6.1-py3-none-any.whl (20.3 kB) Copy SHA256 hash SHA256 Wheel py3
achallonge-1.6.1.tar.gz (16.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page