Skip to main content

PyVisionAuto: Cross-platform desktop automation toolkit with visual image matching, mouse/keyboard control, and screen recording

Project description

PyVisionAuto

PyPI version Python Platform

PyVisionAuto is an end-to-end desktop automation toolkit. It is centered on visual image matching and also includes screen recording, mouse automation, and keyboard automation capabilities.

Scope

  • Linux (X11 session) and Windows
  • Real physical display required

Install

pip install pyvisionauto

System dependencies

Linux

  • python3-tk (for border overlay highlight)
  • xdotool (preferred for window activation)
  • wmctrl (fallback for window activation)
  • ffmpeg (optional, only for recording APIs; install via sudo apt install ffmpeg)

Windows

  • tkinter (bundled with most Python installations on Windows)
  • ffmpeg (optional, only for recording APIs; must be installed and added to system PATH)

Installing ffmpeg on Windows: Download from ffmpeg.org, extract the archive, and add the bin folder to your system PATH.

Quick start

from pyvisionauto import Screen

screen = Screen()
screen.wait("login_button.png", timeout=10).highlight().click()

Activate a window before matching

screen.activate_window("Calculator")
screen.click("button.png")

Runtime screenshot

Highlighted match region during runtime:

PyVisionAuto runtime screenshot with highlighted region

Platform differences

Feature Linux Windows
Screen capture & template matching Supported Supported
Mouse / keyboard automation Supported Supported
Highlight overlay Supported Supported
Window activation xdotool / wmctrl pyautogui (pygetwindow)
Screen recording ffmpeg + x11grab ffmpeg + gdigrab

Screen recording requires ffmpeg installed and added to system PATH. Linux uses x11grab, Windows uses gdigrab.

Notes

  • Wayland-only and headless environments are not currently supported.
  • On Windows with high-DPI scaling, coordinate accuracy may be affected.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvisionauto-0.1.1.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyvisionauto-0.1.1-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file pyvisionauto-0.1.1.tar.gz.

File metadata

  • Download URL: pyvisionauto-0.1.1.tar.gz
  • Upload date:
  • Size: 25.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for pyvisionauto-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6cb53ee1ed761f642c21a71bad3eea9035675f7ea98df0479943ec64eedcf94f
MD5 33c48375702f8715d23f32b99773d2bb
BLAKE2b-256 3954ec79bed0f864c003b0f7db0c17475789d0a52050f01168698c4e145a6084

See more details on using hashes here.

File details

Details for the file pyvisionauto-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pyvisionauto-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for pyvisionauto-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d108562a101e40b5b69ede7a15095e9f6d07943c738049ebd80699a4d196dd9b
MD5 9d1820e05ad2d52297646d5949ce8a53
BLAKE2b-256 4bd782b5b29f4b472fc70b3234269ddda62d2c1924fad4d977500a783281053d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page