rnag/three-play

A Python library for the 3Play API v3

3Play API Helper

A Python wrapper library for the 3Play API v3

• Free software: MIT license
• Documentation: https://three-play.readthedocs.io.

Usage

from three_play.v3 import *
from three_play.v3.models import *

# Assuming you haven't set this via the environment variable
ThreePlayApi.configure('MY-API-KEY')

r = ThreePlayApi.list_media_files(name_partial='Testing')
file_data = r.get('data', [])
files = [MediaFile(**file) for file in file_data]
print(len(files), files)

transcripts = ThreePlayHelper.get_transcripts('my-video-id')
print(len(transcripts), transcripts)

Installing

The 3Play helper library is available on PyPI:

$ python -m pip install three-play

Supported Versions

The three-play helper library officially supports Python 3.7 or higher.

About

I recommend reading the documentation in the source code for important HOW-TO's and info on what each helper function is doing.

I'll need to write some kind of documentation eventually, but that's still pending for now.

At a minimum I recommend setting these 2 environment variables:

• 3PLAY_API_KEY - API Key to use for requests to 3Play API
• INTEGRATION_ID - Service Integration ID on 3Play - for example, an integration /w YouTube

Features

• TODO

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

three-play's Issues

Handle or Address Known Rate Limits

• 3Play API version: 0.1.1
• Python version: 3.11
• Operating System: Mac OS X

Description

I want to update ThreePlayApi model class to add rate limiting (and/or retry and backoff logic) for known APIs.

Per the 3play docs on rate limiting:

• Most APIs have a rate limit of 500 requests/min.
• Retrieving transcript text has a (lower) rate limit of 120 requests/min.

Motivation

I have had need to run a batch script to fetch the transcript text of >100 videos (in bulk), and I ran into the specified rate limit error when attempting it earlier.

I want to retry requests on errors (such as rate limits) automatically, so that requests should eventually succeed after 1 minute, and won't result in an immediate failure due to rate limit being exceeded.

Initial Update

The bot created this issue to inform you that pyup.io has been set up on this repo.
Once you have closed it, the bot will open pull requests for updates as soon as they are available.

Initial Update

The bot created this issue to inform you that pyup.io has been set up on this repo.
Once you have closed it, the bot will open pull requests for updates as soon as they are available.

Make the library strongly-typed

• 3Play API version: 0.1.1
• Python version: 3.11
• Operating System: Mac OS X

Description

I want to update three-play library to be strongly-typed -- similar to my library wystia -- so instead of returning plain dict objects, I want to return dataclasses.

Initial Update

The bot created this issue to inform you that pyup.io has been set up on this repo.
Once you have closed it, the bot will open pull requests for updates as soon as they are available.