https://github.com/vadvergasov/codeforcesapipy

Implementation of https://codeforces.com API
https://github.com/vadvergasov/codeforcesapipy

codeforces codeforces-api github-actions github-page github-wiki module python python3 twine wiki

Last synced: 6 days ago
JSON representation

Implementation of https://codeforces.com API

• Host: GitHub
• URL: https://github.com/vadvergasov/codeforcesapipy
• Owner: VadVergasov
• License: gpl-3.0
• Created: 2020-02-26T06:40:16.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-04T22:37:49.000Z (3 months ago)
• Last Synced: 2024-12-18T02:09:56.531Z (6 days ago)
• Topics: codeforces, codeforces-api, github-actions, github-page, github-wiki, module, python, python3, twine, wiki
• Language: Python
• Homepage:
• Size: 179 KB
• Stars: 27
• Watchers: 1
• Forks: 4
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Codeforces API

[![License](https://img.shields.io/github/license/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/blob/master/LICENSE)

[![Stars](https://img.shields.io/github/stars/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/stargazers)

[![Forks](https://img.shields.io/github/forks/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/network/members)

[![Issues](https://img.shields.io/github/issues/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/issues)

[![Publish to PyPI and create Release.](https://github.com/VadVergasov/CodeforcesApiPy/actions/workflows/publish.yml/badge.svg?branch=master)](https://github.com/VadVergasov/CodeforcesApiPy/actions/workflows/publish.yml)

[![Generate wiki](https://github.com/VadVergasov/CodeforcesApiPy/workflows/Generate%20wiki/badge.svg?branch=master)](https://github.com/VadVergasov/CodeforcesApiPy/wiki)

[![Downloads](https://static.pepy.tech/personalized-badge/codeforcesapipy?period=total&units=international_system&left_color=black&right_color=blue&left_text=Total%20downloads)](https://pepy.tech/project/codeforcesapipy)

![Codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)

==========

Installing

----------

With pip:

```bash

pip install CodeforcesApiPy

```

From the repository:

```bash

git clone https://github.com/VadVergasov/CodeforcesApiPy.git

cd codeforcesapipy

python3 setup.py install

```

Using

---------

```python

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](https://codeforces.com/apiHelp/objects)

Methods

-------

All [API methods](https://codeforces.com/apiHelp/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](https://codeforces.com/apiHelp/objects).

Wiki

--------

Here is link to the [wiki](https://github.com/VadVergasov/CodeforcesApiPy/wiki) for more details.

Examples

---------

Here are some examples of using this library:

* [A2OJ](https://github.com/subodhk01/a2oj) by subodhk01 - allows you to look at your ladder progress.

* [cf_utils](https://github.com/xennygrimmato/cf_utils) by xennygrimmato - allows you to find common solved problems.