Metadata-Version: 2.1
Name: vimeo_downloader
Version: 0.2.0
Summary: Download videos and retrieve metadata from Vimeo.
Home-page: https://github.com/yashrathi-git/vimeo_downloader
Author: Yash Rathi
Author-email: yashrathicricket@gmail.com
License: MIT
Description: 
        # Vimeo Downloader  
        
        ## Features
        Downloads Vimeo videos and retrieve metadata such as views, likes, comments, duration of the video.
        
        * Easy to use and friendly API.
        * Support for downloading private or embed only Vimeo videos.
        * Retrieve direct URL for the video.
        * Lightweight
        
        
        ## Installation
        
        ```bash
        pip install vimeo_downloader
        ```
        
        ## Examples
        
        ## 1. Downloading embed only videos
        `embedded_on` is  the URL of site video is embedded on without query parameters.
        ```python
        from vimeo_downloader import Vimeo
        
        # Replace these two variables to different URL to download that video
        vimeo_url = 'https://player.vimeo.com/video/498617513'
        embedded_on = 'https://atpstar.com/plans-162.html'
        # embedded_on is  the URL of site video is embedded on without query parameters.
        
        v = Vimeo(vimeo_url, embedded_on) 
        
        stream = v.streams # List of available streams of different quality
        # >> [Stream(240p), Stream(360p), Stream(540p), Stream(720p), Stream(1080p)]
        
        # Download best stream
        stream[-1].download(download_directory = 'video', filename = 'test_stream')
        
        # Download video of particular quality, example '540p'
        for s in stream:
        	if s.quality == '540p':
        		s.download(download_directory = 'video', filename = 'test_stream')
        		break
        else: # If loop never breaks
            print("Quality not found")
        ```
        ## 2. Downloading a list of videos
        ```python
        from vimeo_downloader import Vimeo
        
        # Replace these with other list of videos you want to download
        videos = ['https://vimeo.com/440801455',
        		 'https://vimeo.com/504420495',
        		 'https://vimeo.com/481277944']
        
        for video in videos:
        	v = Vimeo(video)
        	stream = v.streams # List of available streams of different quality
        
        	# Selecting and downloading '720p' video
        	for s in stream:
        		if s.quality == '720p': 
        			s.download(download_directory = 'video', filename = v.metadata.title)
        			break
        	else: # If the loop never break
        		print('quality not found')
        ```
        ## Usage
        
        ```python
        >>> from vimeo_downloader import Vimeo
        >>> v = Vimeo('https://vimeo.com/503166067')
        ```
        #### Metadata
        ```python
        >>> meta = v.metadata
        >>> meta.title
        "We Don't Have To Know - Keli Holiday"
        >>> meta.likes
        214
        >>> meta.views
        8039
        >>> meta._fields # List of all meta data fields
        ('id', 'title', 'description'...) # Truncated for readability
        ```
        #### Download stream
        ```python
        >>> s = v.streams
        >>> s
        [Stream(240p), Stream(360p), Stream(540p), Stream(720p), Stream(1080p)]
        >>> best_stream = s[-1] # Select the best stream
        >>> best_stream.filesize
        '166.589421 MB'
        >>> best_stream.direct_url
        'https://vod-progressive.akamaized.net.../2298326263.mp4'
        >>> best_stream.download(download_directory='DirectoryName',
                                filename='FileName')
        # Download video with progress bar and other information,
        # to disable this behaviour use mute=True
        ```
        ### Downloading private or embed only videos 
        ```python
        >>> from vimeo_downloader import Vimeo
        >>> v = Vimeo('https://player.vimeo.com/video/498617513',
                      embedded_on='https://atpstar.com/plans-162.html') 
        ```
        For embed only videos, also provide embedded_on parameter to specify the URL on which video is embedded without query parameters.
        ```python
        >>> v.streams
        [Stream(240p), Stream(360p), Stream(540p), Stream(720p), Stream(1080p)]
        >>> v.streams[-1].download(download_directory='DirectoryName',
                                   filename='FileName')
        # Downloads the best stream with progress bar and other information, 
        # to disable this behaviour use mute=True
        ```
        
        
        ## License
        Distributed under the MIT licence. Read `LICENSE` for more information
        https://github.com/yashrathi-git/vimeo_downloader/blob/main/LICENCE
        
Keywords: vimeo,download,meta data,vimeo downloader,vimeo_downloader,vimeo helper
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
