Metadata-Version: 2.1
Name: vid2pdf
Version: 1.1.0
Summary: Simple helper utility to convert a video file to PDF image series
Home-page: https://github.com/sco1/
Author: sco1
Author-email: sco1.git@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Typing :: Typed
Requires-Dist: Pillow (>=8.3,<9.0)
Requires-Dist: click (>=8.0,<9.0)
Requires-Dist: ffmpy (>=0.3,<0.4)
Requires-Dist: tqdm (>=4.62,<5.0)
Project-URL: Repository, https://github.com/sco1/vid2pdf
Description-Content-Type: text/markdown

# vid2pdf
Simple helper utility to convert a video file to PDF image series

## External Requirements

`vid2pdf` requires ffmpeg to be extracted to the `/utils/ffmpeg` folder. The latest version of ffmpeg can be downloaded from [ffmpeg.org](https://www.ffmpeg.org/download.html). Existing local ffmpeg installations are not currently supported.

If not using a precompiled build, Python must be installed on your local machine. You can download the latest version of Python for your OS from [python.org](https://www.python.org/downloads/)

## Installation

This project utilizes [`poetry`](https://python-poetry.org/) for dependency & environment management. Clone or download this repository to your local machine and create a new environment:

```bash
$ cd <project_dir>
$ poetry install
```

Though it's recommended to utilize `poetry`, the project may also be installed via `pip`:

```bash
$ cd <project_dir>
$ pip install .
```

Alternatively, prebuilt binaries are provided at https://github.com/sco1/vid2pdf/releases

## Usage

`vid2pdf` can be invoked using Python:
```bash
$ python vid2pdf.py
```

Or, if a prebuilt binary is present, this may be called directly
```bash
$ vid2pdf.exe
```

### Input Parameters
Unless otherwise noted, all input parameters are prompted in the CLI
#### `input_video`
The default behavior is to open a GUI dialog for the user to specify a the input video file. An optional `-cli` flag may be passed to bypass this GUI and instead prompt for the video file path in the CLI.

#### `output_dir`
PDF output directory. If this value is not specified, this defaults to the parent directory of the input video.

#### `start_time`
Video start time for capture, as `hh:mm:ss.sss`. If this value is not specified, the beginning of the video is used.

#### `end_time`
Video end time for capture, as `hh:mm:ss.sss`. If this value is not specified, the end of the video is used.

### Examples

```bash
$ python vid2pdf.py
Enter the output directory path [X:\vid2pdf\test]:
Enter start time (hh:mm:ss.sss). Leave blank to use the video start:
Enter end time (hh:mm:ss.sss). Leave blank to use the video end: 00:00:01.000
<ffmpeg output snipped>
Loading 30 frames...
100%|███████████████████████████████████████| 29/29 [00:00<00:00, 852.82it/s]
Generating PDF ... done
```

```bash
$ python vid2pdf.py -cli
Enter the video file path: X:\vid2pdf\test\test_video.mp4
Enter the output directory path [X:\vid2pdf\test]:
Enter start time (hh:mm:ss.sss). Leave blank to use the video start:
Enter end time (hh:mm:ss.sss). Leave blank to use the video end: 00:00:01.000
<ffmpeg output snipped>
Loading 30 frames...
100%|███████████████████████████████████████| 29/29 [00:00<00:00, 852.82it/s]
Generating PDF ... done
```

