SikulPy

Sikuli is pretty awesome, but it requires java. Bleh.

This is a project to provide the same API using regular CPython libraries.

The goal is to be able to run any script which works in the Java IDE.

Use as an app

git clone https://github.com/shish/sikulpy
cd sikulpy
uv run sikulpy ~/Documents/sikuli/foo.sikuli

Use as a library

In pyproject.toml, add:

[project]
dependencies = [
    "sikulpy",
]

In your code:

from sikuli import *

scr = Screen(0)
button = scr.find("test.png")
button.click()

Java-Sikuli compatibility

The parts of the Sikuli API that I'm personally using are fairly stable; I'm using it in production on Linux, with development on OSX and occasional testing on Windows.

Parts of the API which are known to be incomplete have tasks filed here: API Completion