Metadata-Version: 2.3
Name: pixel-patrol-base
Version: 0.9.1
Summary: Image prevalidation tool
Project-URL: Homepage, https://ida-mdc.github.io/pixel-patrol/
Project-URL: Repository, https://github.com/ida-mdc/pixel-patrol
Author: Helmholtz Imaging Engineering & Support Unit MDC
License: MIT
Requires-Python: >=3.12
Requires-Dist: click>=8.2.1
Requires-Dist: dask[distributed]>=2025.5.1
Requires-Dist: duckdb>=1.2.0
Requires-Dist: matplotlib>=3.10.3
Requires-Dist: packaging>=21.0
Requires-Dist: polars>=1.31.0
Requires-Dist: psutil>=6.0.0
Requires-Dist: pyarrow>=21.0.0
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: statsmodels>=0.14.4
Requires-Dist: tqdm>=4.67.1
Requires-Dist: yaspin>=3.4.0
Description-Content-Type: text/markdown

### PixelPatrol Base (pixel-patrol-base)

The Core Engine and Framework for the PixelPatrol Ecosystem.

This package is the essential, non-optional foundation of PixelPatrol. It provides the API, CLI, PixelPatrol processing, and the plugin system that allows other packages (like pixel-patrol-loader-bio) to integrate seamlessly.

It also includes the Processing Framework: It defines the official system for reading files, processing data, and generating the final feature sets.
It includes more universal plug-ins such as basic file-system statistics, as well as plug-ins that don't require additional library installation such as thumbnail generation and standard statistical analysis.

#### 👥 Who Should Install This?

Most end-users should install the main, consolidated package:
```
uv pip install pixel-patrol
```

The main package automatically installs pixel-patrol-base along with the most common loaders and analysis tools.

You should install pixel-patrol-base directly only if you are:

* A Developer: You are building your own custom extension (a new loader, processor, or widget) and need the core API.
* A Power User: You want a minimal installation and plan to manually install other official extensions.

##### 🚀 Installation (Minimal)
To install just the core framework:
```
uv pip install pixel-patrol-base
```

📖 Usage and Documentation  
For instructions please refer to the main documentation:  
https://github.com/ida-mdc/pixel-patrol/