API chit chat

[H09-0]

hi back when i used Sikulix there was an API for all systems can you make one for Oculix ?

also i faced this when i updated to Oculix
"ImportError: No module named Region"

[julienmerconsulting]

Hey @H09-0 — sorry for the late reply, busy week 🙃

Two angles in your post, let me untangle:

1. "API for all systems"

Need a bit of clarification — could mean two different things:

(a) The Java API, importable as a Maven dependency on Linux/macOS/Windows

✅ Still there, exactly as in SikuliX. Same Screen, Region, Pattern, App, plus VNCScreen and ADBScreen. On Maven Central:

<dependency>
  <groupId>io.github.oculix-org</groupId>
  <artifactId>oculixapi</artifactId>
  <version>3.0.2</version>
</dependency>

(b) A native API in Python / JavaScript / .NET (not just Java)

🚧 Roadmap, planned epics:

• #177 Operix — pip install oculix (Python via Py4J)
• #178 Operix-JS — npm install oculix (Node.js via JSON-RPC bridge)
• #179 Operix-NET — dotnet add package OculiX (C# via IKVM)

Python first, hopefully soon. Which direction were you asking about?

2. ImportError: No module named Region

Need a bit more context to debug:

• Running via the OculiX IDE (green Run button)? The IDE auto-injects from sikuli import * at the top of every script — Region should be available without explicit import. If it's not, something's odd, paste the first 10 lines of your script.
• Running via plain python script.py from a terminal? That's CPython, which won't work — OculiX runs on Jython (it needs the Java bridge). Today you'd run it via java -jar oculixide-3.0.3-rc1-windows.jar -r script.py (or -linux / -mac for your OS). The pip install oculix path (Operix — pip install oculix — Python wrapper via Py4J #177 above) is the long-term answer for native CPython.
• Migrating from SikuliX 2.0.5? If you have an old script that used to work and now doesn't, paste the import lines and the OS, I'll check for any regression.

In any case, could you share:

• The first 20 lines of your script
• The command you're using to run it
• Your OS

And I'll get you unblocked.

Cheers,
Julien