game_apis

This repository is for integrating with different apis to allow you to pull player or game data

Install

You can install the api via pip via the command:
sudo python3 -m pip install game-apis

or if you are on windows:
pip install game-apis

Once it's installed you can do
from game_apis.rest import Rest

Config

There are 2 ways to do the config. The preferred way is to read from a config.yaml file as described below. Another way to do it is to pass a json to the Rest class with the same structure as the config.yaml file described below. Here's a simple example:

config_json = {'riot': {'key_id': '<hand enter key before running>'}}
riot = Rest(config_json).Riot

To use some of the REST Apis you need your keys in a config file (e.g. a file called config.yaml). You have the option of importing the config file locally with the local_config=True flag when instantiating an api, otherwise the path is relative to the directory where the api is installed.
Here's an example of the Rest Config:

opendota:
  key_id: null
riot:
  key_id: null
pubg:
  key_id: null
egb:
  key_id: null
  key_secret: null
riotesports:
  key_id: null
fortnitetracker:
  key_id: null

And an example of calling the api with a config file in the same directory as your project:

riot = Rest('config.yaml', local_config=True).Riot

A good way to see what should be in the config is by looking at the base class that loads the config file and seeing what keys it expects. Normally it'll look for the ID of the child class, which is a field on that child class, and then have the parameters that class needs as children of it in the confg.

The same thing is true for data_flow. You have the ID of the class lowercased (ID = 'AZUREBLOB_CREDS') and then as children of that in the config the fields it uses, for example self.config['account_name']. In this case you'd want:

  azureblob_creds:
    account_name: null

Run tests

To run all unit tests in a file do:
python3 -m unittest test.rest.test_open_dota

To run a specific unit test do:
python3 -m unittest test.rest.test_open_dota.TestOpenDota.test_get_lane_roles

Using API

Initialize the rest class with
api = Rest('<path to config.yaml>')

You can find the implemented apis with
api.lookup

An example usage of this repo is

from game_apis.rest import Rest

riot = Rest('config.yaml').Riot
hello = riot.hello_world()