75 lines
2.4 KiB
Python
75 lines
2.4 KiB
Python
from platypush.plugins import action
|
|
from platypush.plugins.google import GooglePlugin
|
|
|
|
|
|
class GoogleYoutubePlugin(GooglePlugin):
|
|
"""
|
|
YouTube plugin.
|
|
|
|
Requires:
|
|
|
|
* **google-api-python-client** (``pip install google-api-python-client``)
|
|
* **oauth2client** (``pip install oauth2client``)
|
|
|
|
"""
|
|
|
|
scopes = ['https://www.googleapis.com/auth/youtube.readonly']
|
|
|
|
# See https://developers.google.com/youtube/v3/getting-started#part
|
|
_default_parts = ['snippet']
|
|
|
|
# See https://developers.google.com/youtube/v3/getting-started#resources
|
|
_default_types = ['video']
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(scopes=self.scopes, *args, **kwargs)
|
|
|
|
@action
|
|
def search(self, parts=None, query='', types=None, max_results=25, **kwargs):
|
|
"""
|
|
Search for YouTube content.
|
|
|
|
:param parts: List of parts to get (default: snippet).
|
|
See the `Getting started - Part <https://developers.google.com/youtube/v3/getting-started#part>`_.
|
|
:type parts: list[str] or str
|
|
|
|
:param query: Query string (default: empty string)
|
|
:type query: str
|
|
|
|
:param types: List of types to retrieve (default: video).
|
|
See the `Getting started - Resources <https://developers.google.com/youtube/v3/getting-started#resources>`_.
|
|
:type types: list[str] or str
|
|
|
|
:param max_results: Maximum number of items that will be returned (default: 25).
|
|
:type max_results: int
|
|
|
|
:param kwargs: Any extra arguments that will be transparently passed to the YouTube API.
|
|
See the `Getting started - parameters
|
|
<https://developers.google.com/youtube/v3/docs/search/list#parameters>`_.
|
|
|
|
:return: A list of YouTube resources.
|
|
See the `Getting started - Resource
|
|
<https://developers.google.com/youtube/v3/docs/search#resource>`_.
|
|
"""
|
|
|
|
parts = parts or self._default_parts[:]
|
|
if isinstance(parts, list):
|
|
parts = ','.join(parts)
|
|
|
|
types = types or self._default_types[:]
|
|
if isinstance(types, list):
|
|
types = ','.join(types)
|
|
|
|
service = self.get_service('youtube', 'v3')
|
|
result = (
|
|
service.search()
|
|
.list(part=parts, q=query, type=types, maxResults=max_results, **kwargs)
|
|
.execute()
|
|
)
|
|
|
|
events = result.get('items', [])
|
|
return events
|
|
|
|
|
|
# vim:sw=4:ts=4:et:
|