Metadata-Version: 2.4
Name: bqat
Version: 1.8.1
Summary: Biometric Quality Assessment Tool - CLI (BQAT-CLI)
Keywords: bqat,cli,biometric
Author: Liam Wu
Author-email: Liam Wu <liam.wu@biometix.com>
License-Expression: Apache-2.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10, <3.15
Project-URL: Changelog, https://biometix.github.io/changelog/#bqat-cli
Project-URL: Documentation, https://biometix.github.io/getting_started/cli.html
Project-URL: Issues, https://github.com/Biometix/bqat-cli/discussions
Project-URL: Releases, https://github.com/Biometix/bqat-cli/releases
Project-URL: Repository, https://github.com/Biometix/bqat-cli
Description-Content-Type: text/markdown

# BQAT

[![PyPI - Version](https://img.shields.io/pypi/v/bqat)](https://pypi.python.org/pypi/bqat)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/bqat)](https://pypi.python.org/pypi/bqat)
[![PyPI - Format](https://img.shields.io/pypi/format/bqat)](https://pypi.python.org/pypi/bqat)
[![PyPI - License](https://img.shields.io/pypi/l/bqat)](https://pypi.python.org/pypi/bqat)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/bqat)](https://pypi.python.org/pypi/bqat)

> A command line interface to [BQAT](https://biometix.github.io/).

BQAT (Biometric Quality Assessment Tool) is an open-source tool designed for assessing the quality of biometric data. It provides evaluations for various modalities, including [face](https://biometix.github.io/modality/face.html), [fingerprint](https://biometix.github.io/modality/fingerprint.html), [iris](https://biometix.github.io/modality/iris.html), and [voice](https://biometix.github.io/modality/speech.html).

## Highlights

- 🚀 A simple Python interface for running `BQAT` workflow, and more.
- 🖥️ Supports macOS, Linux, and Windows.

## Prerequisites

- [Docker](https://www.docker.com/)
- x86-64 or ARMv9 CPU

## Quick Start

1. Install

    ```sh
    pip install bqat
    ```

2. Display version info

    ```sh
    bqat --version
    ```

3. Validate installation via benchmarking

    ```sh
    bqat --benchmark
    ```

4. Run BQAT analysis

    ```sh
    bqat --mode face --input data/face
    ```

5. Run BQAT analysis and compile a EDA report

    ```sh
    bqat --mode fingerprint --input data/fingerprint --report
    ```

## Flags for BQAT

Please refer to the documentation of [BQAT](https://biometix.github.io/) further details.

## Flags for the Python CLI

| Flag | Description |
| --- | --- |
| --help | Print help info. |
| --version, -v | Display version info. |
| --update | Update BQAT backend container. |
| --uninstall | Uninstall BQAT-CLI. |
