Metadata-Version: 2.1
Name: CodeforcesApiPy
Version: 2.0.8
Summary: Implementation of codeforces.com API
Home-page: https://github.com/VadVergasov/CodeforcesApiPy
Author: VadVergasov
Author-email: vadim.vergasov2003@gmail.com
License: GPLv3
Description: 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.
        
Keywords: codeforces api python
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
