Metadata-Version: 2.1
Name: playoff-core
Version: 0.8.3
Summary: Playoff toolbox
Home-page: https://github.com/officina/playoff-core
Author: Mattia Bano
Author-email: dev@officina.cc
License: UNKNOWN
Description: # Requires
        
        Python 3+
        
        # Install
        
        ```Python3
        pip install playoff-core
        ```
        
        # Using
        
        In order to use this toolbox, you need:
        
        - Playoff game;
        - subscription plan that allows to make API calls;
        - a configured client;
        - create two files in the project directory:
            - an `.env` file containing `Client_ID`, `Client_secret` and `hostname` 
        of the corresponding game;
            - a `settings.ini` file which is explained in a section below.
        
        **Example**:
        
        ```
        ORIGINAL_CLIENT_ID=Bf7dhMnM73EQtMjRjOGYyN2VmODhh
        ORIGINAL_CLIENT_SECRET=MGMxYzQ0YzdCmD937tYjUyOWM1NWI3YjlhNTdiODY2MTAtOGE0MS0xS
        ORIGINAL_HOSTNAME="playoff.cc"
        ```
        
        # Settings
        
        Settings available are:
        
        - **Version**: game version;
        - **Player_id**: a player id needed to certain API calls;
        - **Cycle**: time lapse to obtain leaderboard, can have following values:
            - *daily*;
            - *weekly*;
            - *monthly*;
            - *yearly*;
            - *alltime*.
        - **Level**: log message level, can have following values:
            - *debug*;
            - *info*;
            - *warning*. 
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
