semvec/pypi-packages huggingface dataset:
qontinui-api 0.2.0
REST API service for Qontinui GUI automation (maintenance mode)
License: MIT
Requires Python: <3.14,>=3.12
Keywords: gui, automation, api, fastapi, qontinui

# Qontinui API Service

> **Maintenance Mode Notice**
>
> This package is in **maintenance mode**. The recommended approach for GUI automation is now the **qontinui-runner** with direct IPC to the qontinui library, which provides better performance and tighter integration.
>
> This package remains available for developers who want HTTP API access to qontinui functionality. No new features will be added, but critical bug fixes may be applied.
>
> **Important:** This package depends on the `qontinui` core library, which is not yet published to PyPI. For local development, install qontinui from source alongside this package.

REST API service that exposes real qontinui library image recognition capabilities for web-based testing.

## Features

- **Real Qontinui Pattern Matching**: Uses actual qontinui Find operations
- **State Detection**: Detect which states are present in screenshots
- **Location Validation**: Validate locations with image-relative positioning
- **Web-Friendly**: Base64 image support for easy browser integration

## Endpoints

### Vision Operations

#### POST /find
Find a single template match in a screenshot using qontinui's real pattern matching.

```json
{
  "screenshot": "base64_image_data",
  "template": "base64_image_data",
  "similarity": 0.8,
  "search_region": {"x": 0, "y": 0, "width": 100, "height": 100}
}
```

#### POST /find_all
Find all template matches in a screenshot.

#### POST /detect_states
Detect which states from a list are present in a screenshot.

```json
{
  "screenshot": "base64_image_data",
  "states": [...],
  "similarity": 0.8
}
```

#### POST /validate_location
Validate if a location is accessible, with optional image-relative positioning.

## Installation

1. Install Python dependencies:
```bash
pip install -r requirements.txt
```

2. Start the service:
```bash
./start.sh
```

Or manually:
```bash
uvicorn main:app --reload --host 0.0.0.0 --port 8000
```

## API Documentation

When running, interactive API documentation is available at:
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc

## Integration with Frontend

The API accepts base64-encoded images and returns JSON responses with match regions, scores, and detection results. Perfect for integration with the qontinui-web frontend for visual testing and validation.

## Contributing

We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

Please note that this project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

## License

This project is open source. See the [LICENSE](LICENSE) file for details.

## Contact

For questions or issues, please contact jspinak@hotmail.com or open an issue on GitHub.