Metadata-Version: 2.1
Name: vdocipher.py
Version: 0.4.5
Summary: Just a VdoCipher api wrapper for python.
Home-page: https://github.com/puzzlsoftwarehouse/vdocipher.py
Author: Puzzl Software House
Author-email: hello@puzzl.com.br
License: MIT License
Description: # vdocipher.py
        Just a VdoCipher api wrapper for python.
        
        Installing
        --------
        
        ```shell script 
        $ pip install vdocipher.py
        ```    
         
        Using
        --------
        
        ```python 
        import vdocipher 
        
        # First, we need to authenticate our api
        vdocipher.authenticate('VDOCIPHER_API_SECRET')
        
        # Examples:
        
        # obtaining a list of videos
        videos = vdocipher.Video().get_list()
        
        # uploading a video
        new_video = vdocipher.Video(title='title').upload('file')
        
        # obtaining a video
        video = vdocipher.Video(id=1).get()
        
        # search for videos
        videos = vdocipher.Video().query('some_text')
        
        # removing a video
        vdocipher.Video(id=1).delete()
        
        # obtaining OTP
        
        otp = OTP().create(videoid='your_video_id')
        
        # or
        otp = Video(title='test video').upload('file').create_otp()
        
        # opt with anotations
        
         annotate = Annotate(
                    annotation_type='text' # Set type parameter as "rtext" for Dynamic watermark
                    text='Name: {name}, email: {email}, IP: {ip}', # You can add user identifiable information
                    alpha='0.60',
                    x='10',
                    y='10',
                    color='0xFF0000',
                    size='15',
                    interval='5000',
                    skip='200'
                )
         annotate_list = [annotate]
         otp = vdocipher.OTP(annotations=annotate_list).create(videoid='your_video_id')
         
         # generating OTP for offline use
        
         duration = 15 * 24 * 3600 
         rule = LicenseRules(
             can_persist=True,
             rental_duration=duration
         )
         otp = vdocipher.OTP(license_rules=rule).create(videoid='your_video_id')
         
         
        
        ```
        
        Installing dev requirements
        --------
        
        ```shell script 
        $ git clone https://github.com/puzzlsoftwarehouse/vdocipher.py.git
        $ cd vdocipher.py
        $ python -m venv .venv
        $ source .venv/bin/activate
        $ pip install .[dev]
        ```
        
        build and publish
        
        ```shell script
        $ python setup.py sdist bdist_wheel
        $ twine upload -r pypi dist/*
        ```
        
        
        
            
            
            
Keywords: vdocipher video api python wrapper
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: dev
