Metadata-Version: 2.4
Name: yarf
Version: 3.24.22
Summary: Yet Another Robot Framework (YARF) is an interface that allows developers to build complex test scenarios and bootstrap them locally, then work towards automated runs.
Author-email: Hou Nam Chiang <douglas.chiang@canonical.com>, Michał Sawicz <michal.sawicz@canonical.com>, Paolo Gentili <paolo.gentili@canonical.com>, Tim Andersson <tim.andersson@canonical.com>
License-Expression: GPL-3.0
License-File: LICENSE
Requires-Python: !=3.11.0,!=3.11.1,!=3.11.2,!=3.11.3,<3.15,>=3.10.12
Requires-Dist: keysymdef~=1.2.0
Requires-Dist: numpy~=2.2.6; python_version < '3.11'
Requires-Dist: numpy~=2.4.4; python_version >= '3.11' and python_version < '3.12'
Requires-Dist: numpy~=2.5.3; python_version >= '3.12'
Requires-Dist: onnxruntime~=1.23.2; python_version < '3.11'
Requires-Dist: onnxruntime~=1.30.0; python_version >= '3.11'
Requires-Dist: opencv-python~=5.0.0.93
Requires-Dist: owasp-logger~=0.1.3
Requires-Dist: paramiko<6,>=5.0.0
Requires-Dist: pillow~=12.3.0
Requires-Dist: prompt-toolkit>=3.0.38
Requires-Dist: pygments>=2.14.0
Requires-Dist: pyperclip>=1.8.2
Requires-Dist: pyserial>=3.5
Requires-Dist: pytesseract~=0.3.10
Requires-Dist: pyte~=0.8.2
Requires-Dist: python-dateutil>=2.9.0.post0
Requires-Dist: pywayland==0.4.19
Requires-Dist: rapidfuzz>=3.12.1
Requires-Dist: robotframework-sshlibrary~=3.8.0
Requires-Dist: robotframework==7.5
Requires-Dist: typing-extensions~=4.16.0
Requires-Dist: xkbcommon<1.5
Provides-Extra: rapidocr
Requires-Dist: rapidocr~=3.9.1; extra == 'rapidocr'
Description-Content-Type: text/markdown

# Yet Another Robot Framework (YARF)

[![Snapcraft][snapcraft-badge]][snapcraft-site]
[![Documentation status][rtd-badge]][rtd-latest]
[![uv status][uv-badge]][uv-site]
[![Ruff status][ruff-badge]][ruff-site]

**YARF** is a tool built upon the [Robot Framework]
that allows developers to build complex visual test scenarios and bootstrap them
locally, and then work towards automated runs in continuous integration (CI) and
use of platforms/fixtures like [Mir] and VNC with minimal effort.

## Basic Usage

To start YARF in interactive mode, simply run:

```shell
yarf --platform {Mir,Vnc}
```

For more specific use-cases, refer to the [YARF how-to guides][how-to].

## Installation

YARF is available on all major Linux distributions.

On snap-ready systems, you can install it on the command-line with:

```shell
sudo snap install yarf

# Optional: in order to allow rapidocr to increase the process niceness
snap connect yarf:process-control
```

To run YARF from source, clone the repository, navigate to the root, and run (requires the `uv` tool):

```shell
uv sync
uv run yarf
```

## Documentation

The YARF docs provide guidance and learning material about the robot libraries,
resources, metadata, use-cases, and much more:

- [YARF documentation on ReadTheDocs][rtd-latest]

## Community and Support

You can report any issues, bugs, or feature requests on the project's
[GitHub repository][github].

## Contribute to YARF

<!-- TODO: YARF is open source. Contributions are welcome. -->

If you are interested, start with the [contribution guide].

## License and Copyright

YARF is released under the [GNU General Public License Version 3.0](./LICENSE).

© 2025 Canonical Ltd.

[contribution guide]: ./CONTRIBUTING.md
[github]: https://github.com/canonical/yarf
[how-to]: https://canonical-yarf.readthedocs-hosted.com/en/latest/how-to/
[mir]: https://github.com/canonical/mir
[robot framework]: https://robotframework.org/
[rtd-badge]: https://readthedocs.com/projects/canonical-yarf/badge/?version=latest
[rtd-latest]: https://canonical-yarf.readthedocs-hosted.com/en/latest/
[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
[ruff-site]: https://github.com/astral-sh/ruff
[snapcraft-badge]: https://snapcraft.io/yarf/badge.svg
[snapcraft-site]: https://snapcraft.io/yarf
[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json
[uv-site]: https://github.com/astral-sh/uv
