Metadata-Version: 2.1
Name: break-video-to-frames
Version: 1.0.0
Summary: Break a video to it's frames.
Author-email: Alireza Nematollahi <alireza.tehran2020@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Alireza Nematollahi
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/alirezanmt/video_to_frames
Keywords: breaker,videoToFrames,videoBreaker
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: opencv-python
Requires-Dist: tomli; python_version < "3.11"
Provides-Extra: dev
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: pytest; extra == "dev"

# Video To Frames

videoToFrames breaks a video to it's frames and save them in a folder.

## Installation

You can install the videoToFrames from [PyPI](https://pypi.org/project/video_to_frames/):

        python -m pip install break-video-to-frames

## How to use

video to frames is a command line application, named `videoToFrames`. To check it's command-line options:

        $ videoToFrames -h

To break all videos in a folder to frames:

        $ videoToFrames -p your_folder_path

To break a specified video:

        $ videoToFrames -p your_video_path

You can specify a format to save frames (default is `jpg`):

        $ videoToFrames -f png

To see time and number of frames:

        $ videoToFrames -v

To import to your program:

        >>> import videoToFrames
        >>> videoToFrames.__version__
        >>> from videoToFrames.breaker import VideoToFrames
        >>> obj = VideoToFrames(path="your_path", verbose=True, image_format="jpg")
        >>> obj.run_breaking()
