A Python Client for collect and parse public data from the Youtube Data API
Switch branches/tags
Nothing to show
Clone or download
Latest commit d3b7136 Nov 13, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data first commit Jun 21, 2018
docs Merge branch 'master' of github.com:mabrownnyu/youtube-data-api Sep 27, 2018
nbs examples Sep 27, 2018
tests image Nov 11, 2018
youtube_api missing colon Nov 11, 2018
.gitignore resolve attribute error Aug 2, 2018
.readthedocs.yml endless readthedocs nonsense Sep 11, 2018
.travis.yml Encrypt env var Aug 8, 2018
Makefile unittest Aug 8, 2018
README.md documentation of test Nov 11, 2018
requirements.txt Merge branch 'master' of github.com:mabrownnyu/youtube-data-api Sep 27, 2018
setup.py changes to part Nov 8, 2018

README.md

Youtube Data API

PyPI version Build status Documentation Status DOI

This is a Python client for the Python Data API. It was written to accomodate v3 of the API.

Install

It is recommended to install this module by using pip:

pip install youtube-data-api

If you want to use it from source, you'll have to install the dependencies manually:

pip install -r requirements.txt

Quickstart

In order to access the API, you'll need to get a service key from the Google Cloud Console.

Once you have it you can use it to initiate the YoutubeDataApi class.

from youtube_api import YoutubeDataApi

api_key = 'AKAIXXXXXXXX'
yt = YoutubeDataApi(api_key)

yt.search('alexandria ocasio-cortez')

The yt object calls functions that automate the collection of data fields that are both visable and not-visable to everyday users.

Please refer to the documentation for details.

Testing

Static json files used for test are stored in ./tests/data. To test, command line input make test. For further information, please refer to ./tests/readme.md.

Authors

Written by Leon Yin and Megan Brown

If you use this software in your research please cite it as:

@misc{leon_yin_2018_1414418,
  author       = {Leon Yin and
                  Megan Brown},
  title        = {SMAPPNYU/youtube-data-api},
  month        = sep,
  year         = 2018,
  doi          = {10.5281/zenodo.1414418},
  url          = {https://doi.org/10.5281/zenodo.1414418}
}