Metadata-Version: 2.1
Name: yt_iframe
Version: 1.0.4
Summary: YouTube video iframe generator
Home-page: https://github.com/RobbyB97/yt-iframe-python/tree/v1.0.1
Author: Robby Bergers
Author-email: bergersr@my.easternct.edu
License: MIT
Description: YT iframe Generator
        ================
        _yt_iframe_ is a python module which can convert a youtube video link into an embeddable iframe.
        In order to use this module, install it through your terminal.
        
        ``` console
        foo@bar:~$ pip install yt-iframe
        ```
        ___
        ``` python
        # Import statement
        from yt_iframe import yt
        ```
        ___
        ## Using the module
        
        ### yt.video()
        The **video()** function takes the youtube video link as a string argument.
        There are _width_ and _height_ optional arguments, so the size of the iframe can be specified.
        It returns the iframe as a string.
        
        ``` python
        url = 'https://www.youtube.com/watch?v=UzIQOQGKeyI' # (Required)
        width = '560' # (Optional)
        height = '315' # (Optional)
        iframe = yt.video(url, width=width, height=height)
        ```
        ___
        ### yt.channel()
        The **channel()** function takes a youtube channel link as a string argument.
        It returns a list of youtube video links.
        
        ``` python
        url = 'https://www.youtube.com/user/ouramazingspace' # (Required)
        videolist = yt.channel(url)
        ```
        ___
        ### yt.channelDict()
        The **channelDict()** function takes a youtube channel link as a string argument.
        It returns a nested dictionary containing the name of the channel, and video titles.
        
        ``` python
        url = 'https://www.youtube.com/user/ouramazingspace'
        videolist = yt.channelDict(url)
        
        videolist['name'] # Name of channel
        videolist['videos'] # Nested dictionary. Key = video title, Value = link
        ```
        ___
        ### yt.getFrames()
        The **getFrames()** function takes a list of youtube videos as a list argument.
        There are _width_ and _height_ arguments (defaults are 560 and 315 respectively), so the size of the iframes can be specified.
        There is also a _responsive_ argument (defaults to false) which returns html for responsive iframes.
        It returns a list of iframes.
        
        ``` python
        channel = yt.channel('https://www.youtube.com/user/ouramazingspace') # (Required)
        width = '560' # (Optional)
        height = '315' # (Optional)
        responsive = True # (Optional)
        
        # Fixed size iframes
        iframes = yt.getFrames(channel, width=width, height=height)
        
        # Responsive iframes
        iframes = yt.getFrames(channel, responsive=responsive)
        ```
        ___
        ### yt.linkResponsive()
        The **linkResponsive()** function returns a line of html which links the stylesheet needed for responsive iframes.
        Alternatively, you can add this line of html in your head tag.
        '<link rel="stylesheet" href="https://bergers.rocks/packages/yt_iframe.css">'
        ___
        ### yt.videoResponsive()
        The **videoResponsive()** function is similar to the _video()_ function, except it returns the html for a responsive iframe.
        In order to use responsive iframes, make sure the css file is linked in the html file with the _linkResponsive()_ function.
        There are two possible layout options for responsive iframes. _singlecolumn_ takes up 100% the width of the parent element, _twocolumn_ will take up 50% and float left.
        
        ``` python
        url = 'https://www.youtube.com/watch?v=UzIQOQGKeyI' # (Required)
        layout = 'singlecolumn' # (Optional)
        
        video = yt.videoResponsive(url, layout=layout) # Get HTML
        ```
        ___
        ## Changelog
        
        ### == v1.0.4 ==
        * _Add layout argument to videoResponsive() and getFrames()_
        * _Add two column layout option to videoResponsive()_
        
        ### == v1.0.3 ==
        * _Add responsive iframes_
        * _getFrames() arguments changed from framewidth and frameheight to width and height_
        
        ### == v1.0.1 ==
        * _Allow size of iframe to be specified in video() function_
        * _Allow sizes of iframes to be specified in getFrames() function_
        
        ### == v1.0.0 ==
        * _Initial release_
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
