Metadata-Version: 2.4
Name: bqat
Version: 1.7.3
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 :: Security :: Cryptography
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

> BQAT-CLI

[![PyPI - Version](https://img.shields.io/pypi/v/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 terminal interface to [BQAT](https://biometix.github.io/).

## Highlights

- 🚀 A single tool for data analysis workflow with BQAT, and more.
- 🖥️ Supports macOS, Linux, and Windows.

`bqat` is backed by [Biometix](https://www.biometix.com/).

## Prerequisites

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

## Quick Start

1. Install

    ```sh
    pip install bqat
    ```

2. Display help info

    ```sh
    bqat --help
    ```

3. Validate installation via benchmarking

    ```sh
    bqat -B
    ```

4. Run BQAT analysis

    Create a `/data` folder in your working directory for input data.

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

## Flags for BQAT

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

## Flags for the CLI

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