Metadata-Version: 2.0
Name: pytunes-reporter
Version: 0.3.2
Summary: Library to interact with iTunes Reporter API
Home-page: https://github.com/gifbitjapan/pytunes-reporter
Author: Chason Chaffin
Author-email: chason.c@routeone-power.com
License: UNKNOWN
Keywords: itunes reporter financial sales
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Office/Business :: Financial
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: dev
Provides-Extra: test
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: bumpversion; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest (>=3.6); extra == 'test'
Requires-Dist: faker; extra == 'test'
Requires-Dist: responses; extra == 'test'
Requires-Dist: pytest-responses; extra == 'test'
Requires-Dist: coverage; extra == 'test'
Requires-Dist: python-coveralls; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'

==================
pyTunes Reporter
==================

.. image:: https://badge.fury.io/py/pytunes-reporter.svg
    :target: https://badge.fury.io/py/pytunes-reporter

.. image:: https://travis-ci.org/gifbitjapan/pytunes-reporter.svg?branch=master
    :target: https://travis-ci.org/gifbitjapan/pytunes-reporter

.. image:: https://coveralls.io/repos/github/gifbitjapan/pytunes-reporter/badge.svg?branch=master
    :target: https://coveralls.io/github/gifbitjapan/pytunes-reporter?branch=master


A Python Framework for Getting Information Out Of iTunes Reporter API

Overview
----------

The iTunes Reporter interface has a lot of very useful information in it, but
unfortunately Apple only provides a Java Applet to access it, and no API.

This library lets you access that data as native Python objects so that you can
display, analyze, or store it however you like.

``Reporter`` takes your API information (either username and password or
AccessKey), and then lets you request information from the API. In the case of
a report, it downloads the TSV (Tab Separated Values) file, unzips it, and
converts it into a native Python object.

In a coming version, you will also be able to use this via the command-line.

Basic Usage
-------------

To access the iTunes Reporter API, you must first instantiate the ``Reporter``
class, using either your username and password::

    from reporter import Reporter

    rep = Reporter(user_id='user@mydomain.com', password='hunter2')
    print(rep.vendors)
    # ['80012345', '80054321']

Or your AccessKey (obtainable via the web interface, Apple's own Reporter tool,
or using the ``access_token`` property of an already instantiated ``Reporter``
object::

    from reporter import Reporter

    rep = Reporter(access_token='29c656f3-2dcf-1234-5678-123456789abc')
    print(rep.vendors)
    # ['80012345', '80054321']

In the case of using your user_id and password, at the time of your first
request, Reporter will fetch your AccessKey and use it for that request and all
subsequent ones.


