Tune Reporting API SDK for Python documentation

package:tune-reporting-python
label:Tune Reporting API SDK for Python 2.7 and 3.0
purpose:Incorporate Tune Reporting API services.
author:Jeff Tanner, jefft@tune.com
update:$Date: 2016-01-24 22:23:55 PST $
version:1.1.1

Contents:

Indices and tables

Overview

The utility focus of the SDKs is upon the Advertiser Reporting endpoints.

Even though the the breadth of the Management API goes beyond just reports, it is these endpoints that our customers primarily access.

The second goal of the SDKs is to assure that our customers’ developers are using best practices in gathering reports in the most optimal way.

Please see documentation here: Tune Reporting API SDKs

Requirements

Prerequisites

  • Python 2.7 or Python 3.0

Generate API Key

To use SDK, it requires you to Generate API Key

Installation

You can install tune-reporting-python via PyPi or by installing from source.

Via PyPi using pip:

Install from PyPi using package manager for Python: pip

1
$ pip install tune_reporting

Don’t have pip installed? Try installing it, by running this from the command line:

1
$ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python

Via ZIP file:

you can download the source code: ZIP.

1
$ python setup.py install

You may need to run the above commands with sudo.

Code Samples

SDK Examples

Run the following script to view execution of all examples:

1
2
$ make installs
$ make api_key=[API_KEY] examples

SDK Unittests

Run the following script to view execution of all unittests:

1
2
$ make tests-installs
$ make api_key=[API_KEY] tests

SDK Document

Run the following script to generate Doxygen-based documentation:

1
$ make docs

Requires installation of Doxygen.

License

MIT License.

Reporting Issues

We would love to hear your feedback.

Report issues using the Github Issue Tracker.

or Email: sdk@tune.com