.. YouTube module documentation file.
   
YouTube Module
==========================================

Class Reference
------------------------------------------

.. automodule:: youtube
   :members:

Configuration
------------------------------------------

The YouTube module has a number of configuration options that will define
it's behavior. The YouTube module will inherent the same configuration file
that `transmogrifier.py <cli/transmogrifier.py>`_ is provided at runtime; 
by default this file is located at ``/usr/local/etc/transmogrifier.conf``. 
This file can be usurped with a separate configuration file by 
providing ``transmogrifier.py`` with the ``--configFile=`` parameter. 

Options utilized by the YouTube module are designated under the ``[YouTube]`` 
config section, as seen in the transmogrifier.conf file shown below: ::

  [YouTube]

  host=sftp.myco.youtube.com
  username=demo
  ownername=AwesomeDemo
  retryCount=5
  publisherid=10001


**host**
  Specify the server address for uploading your YouTube content.

**username**
  Specify the username used for uploading YouTube content.

  .. note:
    As mentioned previously, the YouTube module utilizes the ``sftp`` system binary
    found at ``/usr/bin/sftp``. The SFTP protocol, by default, utilizes interactive
    authentication when initiating data transfers. In order to facilitate automated
    uploads to YouTube via this module, it will be necessary to configure a 
    Private/Public key pair to utilize for authentication. Please consult work with 
    your YouTube rep if you have questions about establishing this configuration.
    
**retryCount**
  Specify the number of times to attempt an SFTP transfer before giving up.
  
**publisherid**
  Specify your YouTube publisher id.
  
**ownername**
  Specify the Content owner.
  
For more information about working with Transmogrifier modules, 
`click here <../../cli/transmogrifier.py.html#working-with-modules>`_