YouTube API Wrapper Documentation

Transcription

1 YouTube API Wrapper Documentation Release 0.1 Alessandro De Noia (Global Radio) June 09, 2016

2

3 Contents 1 Installation Install the library Basic usage Videos Exceptions 7 4 Indices and tables 9 Python Module Index 11 i

4 ii

5 YouTube API Wrapper Documentation, Release 0.1 Python API client for YouTube. It currently supports get Contents: Contents 1

6 YouTube API Wrapper Documentation, Release Contents

7 CHAPTER 1 Installation 1.1 Install the library Tip: Work in a virtual environment! Using PyPi: $ pip install youtube_api Using setup.py: $ python setup.py install 3

8 YouTube API Wrapper Documentation, Release Chapter 1. Installation

9 CHAPTER 2 Basic usage 2.1 Videos The VideoApi class gives access to the Videos API endpoint.. class youtube_api.client.client(api_key) Generic class with common methods, not to be called directly get_resource(resource_filter, parts, optional_params) Low level generic method to get resource, used by other methods that add specific params for each resource Parameters resource_type string with resource type to create the complete endpoint resource_filter dictionary with the filter to be used parts dictionary with the parts to be returned optional_params dictionary with all the params Returns requests response object class youtube_api.client.videoapi(api_key) Videos endpoint specific client calculate_quota(parts) Returns the quota used for the :param parts: Parts to be checked :return: Quota used get_video_by_id(video_id, parts=( snippet, ), optional_params={}) Returns a video looking up by ID Parameters video_id string parts tuple of strings optional_params dictionary, usually filter params Returns serialised json response get_videos(resource_filter, parts, optional_params) Get info for videos resource Parameters resource_filter dictionary with one key:value pair only 5

10 YouTube API Wrapper Documentation, Release 0.1 Examples: parts tuple of strings optional_params dictionary, usually filter params Returns serialised json response from youtube_api.client import VideoApi client = VideoApi('API_KEY') video = client.get_video_by_id('video Id') By default only snippet part is retrieved. Querying for more parts. results in an higher quota consumption. It s possible to check the quota used before submitting the query by calling: client.calculate_quota(('snippet', 'contentdetails')) >>> 4 6 Chapter 2. Basic usage

11 CHAPTER 3 Exceptions exception youtube_api.exceptions.badparametersrequest Bad Parameters in the requests exception youtube_api.exceptions.filternotallowed Filter not allowed for the resource exception youtube_api.exceptions.onefilterallowed exception youtube_api.exceptions.optionalparamnotallowed exception youtube_api.exceptions.partnotallowed Request part not allowed for the resource exception youtube_api.exceptions.youtubebadrequest YouTube Bad request encapsulation exception youtube_api.exceptions.youtubeforbidden YouTube Forbidden request encapsulation 7

12 YouTube API Wrapper Documentation, Release Chapter 3. Exceptions

13 CHAPTER 4 Indices and tables genindex modindex search 9

14 YouTube API Wrapper Documentation, Release Chapter 4. Indices and tables

15 Python Module Index y youtube_api.client, 5 youtube_api.exceptions, 7 11

16 YouTube API Wrapper Documentation, Release Python Module Index

17 Index B BadParametersRequest, 7 C calculate_quota() (youtube_api.client.videoapi method), 5 Client (class in youtube_api.client), 5 F FilterNotAllowed, 7 G get_resource() (youtube_api.client.client method), 5 get_video_by_id() (youtube_api.client.videoapi method), 5 get_videos() (youtube_api.client.videoapi method), 5 O OneFilterAllowed, 7 OptionalParamNotAllowed, 7 P PartNotAllowed, 7 V VideoAPI (class in youtube_api.client), 5 Y youtube_api.client (module), 5 youtube_api.exceptions (module), 7 YouTubeBadRequest, 7 YouTubeForbidden, 7 13