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.2.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.2-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyvisionauto-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 7f45caa11baf18baa8260f56dcace2de1fc478dbb619bf2e65bbffac62a37e3f
MD5 b82cc8ca3c43749f331eb1c283c1db57
BLAKE2b-256 62cb0af208a67e27fb6e9968c9dcf751a9d48fe340eaffff2d3dff006c9ddf6b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyvisionauto-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 17d0cce2cc31b5c01a1d5bd04fa96be2654f001320ef7f5f12eae3a82836d69c
MD5 f373f9d44ff2d9bacb6e7db169348f16
BLAKE2b-256 3e6ce942b21fa286191d1ee7306b3f22edd94ad1a643bcd7490fe40f96344edb

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