A simple yet powerful wrapper for the YouTube Analytics API.
Reason this release was yanked:
Development direction has changed since this release
Project description
analytix
A simple yet powerful wrapper for the YouTube Analytics API.
CPython versions 3.7 through 3.11-dev and PyPy versions 3.7 through 3.9 are officially supported.
Windows, MacOS, and Linux are all supported.
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 across multiple sessions 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
What does analytix do?
The YouTube Studio provides a fantastic interface where creators can view some incredibly detailed analytics for their channel. However, there's no way to perform programmatical operations on the data to do some proper analysis on it. This is where analytix comes in.
The process of analysing data on the YouTube Studio is comprised of two steps:
- Retrieving the data to be analysed and visualised
- Presenting that data to the user
analytix aims to handle step one as comprehensively as possible, allowing analysts to use tools such as pandas and Matplotlib to work on the data without having to faff around with Google's offerings.
Installation
To install the latest stable version of analytix, use the following command:
pip install analytix
You can also install the latest development version using the following command:
pip install git+https://github.com/parafoxia/analytix
You may need to prefix these commands with a call to the Python interpreter depending on your OS and Python configuration.
Additional support
You can also install analytix with additional libraries to provide extra functionality:
analytix[excel]
— support for exporting reports to Excel spreadsheetsanalytix[types]
— type stubs for type-hinted projects
To install multiple at once, use commas:
pip install "analytix[excel,types]"
Note that while analytix includes native support for DataFrame and Arrow table conversions, these libraries are not installed automatically. You will need to install these libraries yourself to use these features.
OAuth authentication
All requests to the YouTube Analytics API need to be authorised through OAuth 2. In order to do this, you will need a Google Developers project with the YouTube Analytics API enabled. You can find instructions on how to do that in the API setup guide, or on this video.
When analytix boots up for the first time, it will display a link. You'll need to follow that link and run through the OAuth workflow. Once that's done, analytix saves the tokens to the disk (if you plan to run analytix on a server, make sure these are in a safe place). This includes your refresh token, which analytix will automatically use to refresh your access token when needed.
This means you should only have to authorise analytix, at most, every week. More details regarding how and when refresh tokens expire can be found on the Google Identity documentation.
Logging
If you want to see what analytix is doing, you can enable the packaged logger:
import analytix
analytix.enable_logger()
If anything is going wrong, or analytix appears to be taking a long time to fetch data, try enabling the logger in DEBUG mode.
Usage
Retrieving reports from the YouTube Analytics API is easy. The below example loads credentials from a secrets file, and gets day-by-day data on views, likes, and comments from US from the last 28 days:
from analytix import Client
client = Client("./secrets.json")
report = client.retrieve_report(
dimensions=("day",),
filters={"country": "US"},
metrics=("views", "likes", "comments"),
)
report.to_csv("./analytics.csv")
If you want to analyse this data using additional tools such as pandas, you can directly export the report as a DataFrame:
# Return as a pandas DataFrame:
df = report.to_pandas()
# Return as an Apache Arrow table:
table = report.to_arrow()
# Return as a Polars DataFrame:
df = report.to_polars()
You can also fetch groups and group items:
from analytix import Client
client = Client("./secrets.json")
groups = client.fetch_groups()
# If you want to get the items within a group:
items = client.fetch_group_items(groups[0].id)
To read up further, have a look at the documentation, or have a look at some examples.
Contributing
Contributions are very much welcome! To get started:
- Familiarise yourself with the code of conduct
- Have a look at the contributing guide
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
Built Distribution
Hashes for analytix-4.0.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d606af560e266a8b5b045e7a497d69f426f6a590342a5570dd76a7b6b0e03a77 |
|
MD5 | 047cfdd57fa46ee8e15a313f09ee2fd2 |
|
BLAKE2b-256 | 7ef88229509272ae62ec23655c6398cc54f4a637a9972cc3f72f0ccae57cf77e |