README.md

Codeforces API

Installing

With pip:

pip install CodeforcesApiPy

From the repository:

git clone https://github.com/VadVergasov/CodeforcesApiPy.git
cd codeforcesapipy
python3 setup.py install

Using

import codeforces_api

cf_api = codeforces_api.CodeforcesApi(api_key, secret) # Authorized access to api.
anonim_cf_api = codeforces_api.CodeforcesApi() # Unauthorized access to api.

parser = codeforces_api.CodeforcesParser() # Create parser.

Types

All types are defined in types.py. They are all completely in line with the Codeforces API's definition of the types

Methods

All API methods are located in the CodeforcesAPI class. They are renamed to follow common Python naming conventions. E.g. contest.hacks is renamed to contest_hacks and user.actions to user_actions.

Transferring to 2 version

In the second version, all objects are represented as a class, so if you want to get a handle of the user you need to do like this: user.handle. You can read about all fields on Codeforces API objects.

Wiki

Here is link to the wiki for more details.

Examples

Here are some examples of using this library:

• A2OJ by subodhk01 - allows you to look at your ladder progress.
• cf_utils by xennygrimmato - allows you to find common solved problems.