Skip to main content

A GameBench API Client Library.

Project description

A Python Client for the GameBench API

Build Status Coverage Quality Gate Status BCH compliance Gitter

Please check out our ZenHub Board for open issues and feature requests.

Repository: GitHub

For full documentation, go to the ReadtheDocs page.



To install, run pip install GameBenchAPI-PyClient-BigFish

The GameBench API Client library supplies a high-level object-oriented interface to the GameBench API. It is built in Python 3.7 and uses the Requests library and Pandas data frames to easily integrate into data analysis software.

The library has two main architectural components; the models and API packages. The API package is responsible for URL requests and dealing with the responses. The models are the objects representing the data returned. A mediator provides the glue between the api and the models.

As a user of the library, you should only ever need to interact with the models creator class and the model objects it can return.

Right now, the models are very thin. They only contain a property that has the data frame assigned. Over time we would like to add common functionality, like aggregates, to these classes.

The Basics

To make a request, import the ModelCreator class. Instantiating the ModelCreator requires two arguments. The first is a CamelCase style 'model' named after the metric that you are looking for; the model is dynamically imported based on this name. The second argument is a dictionary that must include specific key/value pairs for querying the GameBench API.

from gamebench_api_client.models.creator.model_creator import ModelCreator

time_series_request = {
    'session_id': '66d926f47ff5a7a5d853d1058c6305614e1ae6a5'

creator = ModelCreator('Cpu', time_series_request)
cpu_time_series = creator.get_model()

results =


      appUsage  daemonUsage    gbUsage  timestamp  totalCpuUsage
0  1372571.375            0  12.658228       5257      39.688461

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for GameBenchAPI-PyClient-BigFish, version 1.0.3
Filename, size File type Python version Upload date Hashes
Filename, size GameBenchAPI_PyClient_BigFish-1.0.3-py3-none-any.whl (53.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size GameBenchAPI-PyClient-BigFish-1.0.3.tar.gz (24.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page