Skip to content

Latest commit

 

History

History
131 lines (99 loc) · 5.58 KB

README.md

File metadata and controls

131 lines (99 loc) · 5.58 KB
Raw

Build Docs Upload Python Package

PillarGG YouTube Uploader

Upload Youtube Videos and more via Python.

Getting Started

pip install pillar-youtube-upload

You can read more below and on the docs.

This project uses the Youtube Data API.

All implementations of youtube upload needs some form of authentication.

Client Side youtube upload

To upload youtube videos as a client, you need to follow this guide.

Server Side youtube upload

To upload youtube videos as a server, you need to follow this guide.

Getting a youtube api key

  1. First, you need to go to this website.
  2. If prompted, select a project, or create a new one.
  3. Use the Library page to find and enable the YouTube Data API v3.
  4. Go to the credentials page.
  5. Click Create Credentials > OAuth client ID.
  6. Select the Web application app type.
  7. Fill in the form and click create. For testing redirect URIs that refer to the local machine with http://localhost:8080.
  8. Download the client_secret.json file from the API Console and securely store the file in a location that only your application can access. By default, the application gets this file from the directory your script is being ran in. The path can also be changed when the class YoutubeUploader is being initialized.
  9. Get your client_id and client_secret.

We recommend that you design your app's auth endpoints so that your application does not expose authorization codes to other resources on the page.

The key must have the scope 'https://www.googleapis.com/auth/youtube.upload'.

Usage Info

The variables client_id and client_secret are how Google identify your application. These are specified in the initialization parameters or in the client_secrets.json file. The variables access_token and refresh_token are how Google's APIs differentiate between different YouTube channels. These are specified in the authenticate method.

This module uploads a given video to a youtube channel, as such there are 2 things this module needs.

  • A video

  • Video Options

    • Title
    • Description
    • Tags
    • Category
    • Status
    • DeclaredMadeForKids

  • A channel to upload to(In the form of a authentication file)

  • The authentication file should contain the following:

    • access_token: token_here
    • refresh_token: token_here
    • scope: scope_here
    • token_type: Bearer
    • expires_in: 3599

This file should be called client_secrets.json and exist in the directory this script is.

Usage

0. Importing the package

# youtube upload api
from youtube_upload.client import YoutubeUploader

1. Instantiating an uploader

uploader = YoutubeUploader(client_id,client_secret)

or

uploader = YoutubeUploader()

If a client_secrets.json is present in the current working directory (downloaded from the Credentials Control Panel in the Google Cloud Console when you create the application). or

uploader = YoutubeUploader(secrets_file_path=secrets_file_path_here)

You can specify the path to the file with the secrets_file_path parameter.

2. Authentication

If you run authenticate with no parameters and no oauth.json, it opens a web page locally that you can use to sign into the YouTube Channel you want to upload the video to.

uploader.authenticate()

or

uploader.authenticate(access_token=access_token_here, refresh_token=refresh_token_here)

OR

uploader.authenticate(oauth_path='oauth.json')

3. Uploading the video

# Video options
options = {
    "title" : "Example title", # The video title
    "description" : "Example description", # The video description
    "tags" : ["tag1", "tag2", "tag3"],
    "categoryId" : "22",
    "privacyStatus" : "private", # Video privacy. Can either be "public", "private", or "unlisted"
    "kids" : False, # Specifies if the Video if for kids or not. Defaults to False.
    "thumbnailLink" : "https://cdn.havecamerawilltravel.com/photographer/files/2020/01/youtube-logo-new-1068x510.jpg" # Optional. Specifies video thumbnail.
}

# upload video
uploader.upload(file_path, options)

Parameter tags should be list of strings only. The parameter categoryId refers to YouTube internal categories, more information can be found here.

4. Closing the uploader

uploader.close()

This method deletes the OAuth file. If you do not want this behavior, skip calling this function.