diff --git a/README.md b/README.md index 8cc3933..14db259 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # sikulix4python + +*(currently paused --- will be continued 2022 hopefully;-)* + Use SikuliX from real [Python via py4j](https://www.py4j.org) (but no need to know, how it works ;-) **under development -- no guarentee for anything :-)** @@ -6,8 +9,9 @@ Use SikuliX from real [Python via py4j](https://www.py4j.org) (but no need to kn ... but you might post issues (questions, bugs, ideas, requests, ...) **What you need** - - the latest 1.1.4 sikulixapi.jar (https://raiman.github.io/SikuliX1/downloads.html) - - a Python installation 2.7 up to 3.7 (3.7 recommended) + - the latest ``sikulixapi.jar (2.0.5+)`` ([download from here](https://raiman.github.io/SikuliX1/downloads.html)) + - a Python installation 2.7 up to 3.9 (testing on 3.9) + - run ``pip install py4j`` to get the support on the Python side - a mature Python IDE (I use IntelliJ's PyCharm) or just a Python REPL. **How to test** @@ -28,15 +32,16 @@ Currently you have to look into the Python files, to find out, what is possible. Before running Python scripts this way, you have to start a SikuliX server instance manually: -``java -jar path-to/sikulixapi.jar pythonserver`` +``java -jar path-to/sikulixapi.jar -p`` -When you see this in the terminal window, it is running: +When you see this in the commandline window, it is running: ``` -März 15, 2019 10:26:20 VORM. py4Java.GatewayServer fireServerStarted -INFO: Gateway Server Started +[info] SikulixAPI: Running py4j server on port 25333 ``` +To stop the server you can use the known stop hotkey (Windows: ALT-SHIFT-C, Mac: CMD-SHIFT-C). + **What is the plan** - have the complete official SikuliX API with docs available at time of script development (autocomplete, docs, help, ...) - be able to additionally access every public method from the SikuliX Java API (you must know the method signature) @@ -48,8 +53,8 @@ INFO: Gateway Server Started - anything might be changed at any time without notice - errors and warnings you get in the terminal window can be ignored, as long as it works as intended on the Python side - output coming from the SikuliX Java API is currently only going to the terminal window -- my current development work is on macOS 10.14, Java 11, Python 3.7 with PyCharm -- no tests on Windows nor Linux yet +- my current development work is on macOS 11, Windows 10, Java 11/15, Python 3.9 with PyCharm +- no tests on Linux yet **An example** diff --git a/testSikulix4python.py b/testSikulix4python.py index 134a408..721a84a 100644 --- a/testSikulix4python.py +++ b/testSikulix4python.py @@ -9,6 +9,8 @@ #print(sxClassHelp("Region")); exit() +#hover(100,100); exit() + reg = Region() print(reg) reg.setX(100).setW(300)