Metadata-Version: 2.4
Name: flicker-detector
Version: 1.0.6
Summary: Metapackage: flicker-detector[cpu] or flicker-detector[gpu] on Windows x64 (one backend only; same console script names).
Author: internal
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Environment :: Console
Classifier: Topic :: Multimedia :: Video
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Provides-Extra: cpu
Requires-Dist: flicker-detector-cpu; (platform_system == "Windows" and platform_machine == "AMD64") and extra == "cpu"
Provides-Extra: gpu
Requires-Dist: flicker-detector-gpu; (platform_system == "Windows" and platform_machine == "AMD64") and extra == "gpu"

# flicker-detector

**Umbrella (metapackage) on PyPI.** This project ships almost no code: it declares optional extras so you can install **one** Windows x64 backend with a single command. Each backend provides the same three console entry points; do not install two backends in the same environment.

| Extra | Pulls in | When to use |
|--------|-----------|-------------|
| `[cpu]` | `flicker-detector-cpu` | CPU-only detection (bundled exes). |
| `[gpu]` | `flicker-detector-gpu` | GPU build when published on PyPI. |

- **Python** ≥ 3.10  
- **OS**: Windows **64-bit** (extras are marked for `AMD64`)

## Install

**CPU (recommended default):**

```powershell
py -m pip install -U "flicker-detector[cpu]"
```

**GPU:**

```powershell
py -m pip install -U "flicker-detector[gpu]"
```

Requires the **`flicker-detector-gpu`** package to exist on the index you use (e.g. PyPI). If resolution fails, install the GPU wheel directly from its project page.

**Important:** use **either** `[cpu]` **or** `[gpu]`, not both — `flicker-detector`, `flicker-detector-server`, and `flicker-detector-client` would conflict.

## Commands (after installing one backend)

| Command | Role |
|---------|------|
| `flicker-detector` | Local CLI: video / image folder / image sequence → JSON |
| `flicker-detector-server` | Web UI + HTTP API |
| `flicker-detector-client` | Submit jobs to a running server |

## Backend-only install (skip this umbrella)

If you only want the backend package:

```powershell
py -m pip install flicker-detector-cpu
# or, when available:
py -m pip install flicker-detector-gpu
```

Same executables as with `[cpu]` / `[gpu]`; you do not need `flicker-detector` on top unless you want the extra indirection.

## Source and issues

Algorithm details, building from source, and bug reports: see the **flicker-detector-cpu** (or GPU) repository and main project README, not this empty metapackage.
