Skip to content

Latest commit

 

History

History
114 lines (82 loc) · 3.67 KB

README.md

File metadata and controls

114 lines (82 loc) · 3.67 KB
Raw

pychallonge

image

Pychallonge provides python bindings for the CHALLONGE! API. The pychallonge module was created by Russ Amos

pychal

Pychal was a fork of pychallonge. The pychal module has been merged into the pychallonge. If you are still using pychal you have to migrate to pychallonge because it is not longer maintained

Requirements

  • iso8601
  • tzlocal
  • pytz
  • requests

Python version support

  • 2.7
  • 3.4+

Installation

For the stable version

pip install pychallonge

For latest development

pip install -e git+http://github.com/ZEDGR/pychallonge#egg=pychallonge

Usage

import challonge

# Tell pychallonge about your [CHALLONGE! API credentials](http://api.challonge.com/v1).
challonge.set_credentials("your_challonge_username", "your_api_key")

# Retrieve a tournament by its id (or its url).
tournament = challonge.tournaments.show(3272)

# Tournaments, matches, and participants are all represented as normal Python dicts.
print(tournament["id"]) # 3272
print(tournament["name"]) # My Awesome Tournament
print(tournament["started_at"]) # None

# Retrieve the participants for a given tournament.
participants = challonge.participants.index(tournament["id"])
print(len(participants)) # 13

# Start the tournament and retrieve the updated information to see the effects
# of the change.
challonge.tournaments.start(tournament["id"])
tournament = challonge.tournaments.show(tournament["id"])
print(tournament["started_at"]) # 2011-07-31 16:16:02-04:00

See challonge.com for full API documentation.

API Issues

The Challonge API has some issues with the attachments endpoints. The create and update endpoints are not working correctly. When you try to upload an attachment with asset(file) the API returns 500 internal server error. The same happens with asset + description. This issue has been reported to Challonge.

Another issue is the check in process has strange behaviour. When you undo check in a participant the field 'checked_in' remains True but in the website the participant is correctly not checked in. That's why the module does not have any tests on this.

Fixed by pychallonge: In the datetime fields the api returns random timezone offsets, pychallonge convert those to your machine's local time. Also you can set any timezone you want with set_timezone function.

Running the unit tests

Pychallonge comes with a set of unit tests. The tests are not comprehensive, but do utilize each method and verify basic functionality.

In order to test behavior of the python bindings, API calls must be made to CHALLONGE!, which requires a username and api key. To run the tests with your credentials, set CHALLONGE_USER and CHALLONGE_KEY appropriately in your environment.

$ git clone http://github.com/ZEDGR/pychalllonge pychallonge
$ CHALLONGE_USER=my_user CHALLONGE_KEY=my_api_key python pychal/tests.py
...............................
----------------------------------------------------------------------
Ran 31 tests in 98.176s

OK

Note that several tournaments are created, published, started, and completed over the course of the unit tests. These should be cleaned up by the end, but if any of the tests fail they may not be cleaned up. As long as the basic functions work, you can clean up errant tournaments as follows.

import challonge
challonge.set_credentials("my_user", "my_api_key")
for t in challonge.tournaments.index():
    if t["name"].startswith("pychal"):
        challonge.tournaments.destroy(t["id"])