Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smappnyu/youtube-data-api
A Python Client for collect and parse public data from the Youtube Data API
https://github.com/smappnyu/youtube-data-api
api api-wrapper data python python-client research research-tool youtube youtube-api-v3 youtube-search
Last synced: about 1 month ago
JSON representation
A Python Client for collect and parse public data from the Youtube Data API
- Host: GitHub
- URL: https://github.com/smappnyu/youtube-data-api
- Owner: SMAPPNYU
- License: mit
- Created: 2018-06-21T02:56:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-26T15:37:27.000Z (over 1 year ago)
- Last Synced: 2024-10-11T20:02:48.528Z (about 1 month ago)
- Topics: api, api-wrapper, data, python, python-client, research, research-tool, youtube, youtube-api-v3, youtube-search
- Language: Jupyter Notebook
- Homepage: https://youtube-data-api.readthedocs.io/en/latest/index.html
- Size: 12.7 MB
- Stars: 79
- Watchers: 5
- Forks: 31
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YouTube Data API
This is a Python client for the [YouTube Data API](https://developers.google.com/youtube/v3/). The `youtube-data-api` package is a wrapper to simplify [GET requests](https://www.w3schools.com/tags/ref_httpmethods.asp) and JSON response parsing from the API. This package was written for version 3 of the API, with some minor future proofing.
## Install
We recommend you [install this module using pip](https://pypi.org/project/youtube-data-api/):
```
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](https://developers.google.com/youtube/registering_an_application#Create_API_Keys) from the [Google Cloud Console](https://console.cloud.google.com/).
Once you have it you can use the API key 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](http://bit.ly/YouTubeDataAPI) 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. Michael Liu helped write and document tests.
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}
}
```
## Contributions
We are actively seeking core maintainers and contributors!
We will be documenting best practices and procedures for contributing code
If you see a typo or documentation that is not clear, please make a pull request!