Skip to main content

A simple yet powerful API wrapper to make getting analytical information from the YouTube Analytics API easier than ever.

Project description

analytix

PyPi version PyPI pyversions PyPI - Implementation PyPI - Status PyPI - Downloads

Maintenance GitHub Release Date GitHub last commit Read the Docs License

A simple yet powerful API wrapper to make getting analytical information from the YouTube Analytics API easier than ever. More services are coming in the future.

Features

  • Pythonic syntax lets you feel right at home
  • Dynamic error handling saves hours of troubleshooting, and makes sure only valid requests count toward your API quota
  • A clever interface allows you to make multiple requests per session without reauthorising
  • Extra support allows the native saving of CSV files and conversion to DataFrame objects
  • Easy enough for beginners, but powerful enough for advanced users

Installation

You need Python 3.6.0 or greater to run analytix. It is recommended you install analytix in a virtual environment.

To install the latest stable version of analytix, use the following command:

pip install analytix

To install with optional dependencies, use the following command:

pip install "analytix[opt]"

You can also install the latest development version using the following command:

pip install git+https://github.com/parafoxia/analytix.git@develop

You may need to prefix these commands with py -m or python3.9 -m (or similar) depending on your OS.

Quickstart

Before you begin, you will need to have a Google Developers project with the YouTube Analytics API enabled. You can find instructions on how to do that in the YouTube Analytics API docs.

Once you've done that, pulling reports down is easy. The below example loads credentials from a secrets file, and gets as much information as possible from the last 28 days.

import datetime as dt

from analytix import YouTubeAnalytics

client = YouTubeAnalytics.from_file("./secrets.json")
start_date = dt.date.today() - dt.timedelta(days=28)
report = client.retrieve(start_date, dimensions=("day",))
report.to_csv("./analytics-28d.csv")

To read up further, have a look at the documentation.

License

The analytix module for Python is licensed under the BSD-3-Clause License.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

analytix-2.0.0.dev5.tar.gz (16.9 kB view hashes)

Uploaded Source

Built Distribution

analytix-2.0.0.dev5-py3-none-any.whl (17.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page