Metadata-Version: 2.1
Name: vhcalc
Version: 0.2.2
Summary: It's a client-side library that implements a custom algorithm for extracting video hashes (fingerprints) from any video source.
Home-page: https://github.com/yoyonel/vhcalc
License: MIT
Author: Lionel Atty
Author-email: yoyonel@hotmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Distance (>=0.1.3,<0.2.0)
Requires-Dist: ImageHash (>=4.2.1,<5.0.0)
Requires-Dist: bitstring (>=3.1.9,<4.0.0)
Requires-Dist: click-path (>=0.0.5,<0.0.6)
Requires-Dist: click-pathlib (>=2020.3.13,<2021.0.0)
Requires-Dist: colorama (==0.4.4)
Requires-Dist: imageio-ffmpeg (>=0.4.5,<0.5.0)
Requires-Dist: loguru (>=0.6.0,<0.7.0)
Requires-Dist: numpy (>=1.22.3,<2.0.0)
Requires-Dist: rich[spinner] (>=11.2.0,<12.0.0)
Project-URL: Repository, https://github.com/yoyonel/vhcalc
Description-Content-Type: text/markdown

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Github Actions](https://github.com/yoyonel/vhcalc/actions/workflows/python-check.yaml/badge.svg)](https://github.com/yoyonel/vhcalc/wayback-machine-saver/actions/workflows/python-check.yaml)

[![PyPI Package latest release](https://img.shields.io/pypi/v/vhcalc.svg?style=flat-square)](https://pypi.org/project/vhcalc/)
[![PyPI Package download count (per month)](https://img.shields.io/pypi/dm/vhcalc?style=flat-square)](https://pypi.org/project/vhcalc/)
[![Supported versions](https://img.shields.io/pypi/pyversions/vhcalc.svg?style=flat-square)](https://pypi.org/project/vhcalc/)

[![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/yoyonel/vhcalc?sort=semver)](https://hub.docker.com/r/yoyonel/vhcalc/)

# vhcalc

It's a client-side library that implements a custom algorithm for extracting video hashes (fingerprints) from any video source.

## Getting Started

### Prerequisites
* [Python](https://www.python.org/downloads/)

## Usage

```sh
$ export_imghash_from_media --help  
Usage: export_imghash_from_media [OPTIONS]

  This script exporting binary images hashes (fingerprints) from (any) media
  (video file)

Options:
  --version                       Show the version and exit.
  -r, --medias_pattern PATH-OR-GLOB
                                  Pattern to find medias  [required]
  -o, --output-file PATH          File where to write images hashes.
  --help                          Show this message and exit.
```


## Docker

Docker hub: [yoyonel/vhcalc](https://hub.docker.com/r/yoyonel/vhcalc/)

```sh
$ docker run -it yoyonel/vhcalc:main --help
Usage: export_imghash_from_media [OPTIONS]

  This script exporting binary images hashes (fingerprints) from (any) media
  (video file)

Options:
  --version                       Show the version and exit.
  -r, --medias_pattern PATH-OR-GLOB
                                  Pattern to find medias  [required]
  -o, --output-file PATH          File where to write images hashes.
  --help                          Show this message and exit.
```

## Contributing
See [Contributing](contributing.md)

## Authors
Lionel Atty <yoyonel@hotmail.com>


Created from [Lee-W/cookiecutter-python-template](https://github.com/Lee-W/cookiecutter-python-template/tree/1.1.2) version 1.1.2

