optimisewait 0.1.0__py3-none-any.whl

optimisewait/__init__.py

@@ -0,0 +1,66 @@
+import pyautogui
+from time import sleep
+
+_default_autopath = r'C:\\'
+
+def set_autopath(path):
+    global _default_autopath
+    _default_autopath = path
+
+def optimiseWait(filename, dontwait=False, specreg=None, clicks=1, xoff=0, yoff=0, autopath=None):
+    global _default_autopath
+    autopath = autopath if autopath is not None else _default_autopath
+
+    if not isinstance(filename, list):
+        filename = [filename]
+    if not isinstance(clicks, list):
+        clicks = [clicks] + [1] * (len(filename) - 1)
+    elif len(clicks) < len(filename):
+        clicks = clicks + [1] * (len(filename) - len(clicks))
+
+    clicked = 0
+    while True:
+        findloc = None
+        for i, fname in enumerate(filename):
+            try:
+                if specreg is None:
+                    loc = pyautogui.locateCenterOnScreen(fr'{autopath}\{fname}.png', confidence=0.9)
+                    if loc and clicked == 0:
+                        findloc = loc
+                        clicked = i + 1
+                else:
+                    loc = pyautogui.locateOnScreen(fr'{autopath}\{fname}.png', region=specreg, confidence=0.9)
+                    if loc:
+                        findloc = loc
+                        clicked = i + 1
+            except pyautogui.ImageNotFoundException:
+                continue
+
+        if dontwait is False:
+            if findloc:
+                break
+        else:
+            if not findloc:
+                return {'found': False, 'image': None}
+            else:
+                return {'found': True, 'image': filename[clicked - 1]}
+        sleep(1)
+
+    if findloc is not None:
+        if specreg is None:
+            x, y = findloc
+        else:
+            x, y, width, height = findloc
+        xmod = x + xoff
+        ymod = y + yoff
+        sleep(1)
+
+        click_count = clicks[clicked - 1] if clicked > 0 else 0
+        if click_count > 0:
+            for _ in range(click_count):
+                pyautogui.click(xmod, ymod)
+                sleep(0.1)
+        
+        return {'found': True, 'image': filename[clicked - 1]}
+    
+    return {'found': False, 'image': None}

optimisewait-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 AMA Mazing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

optimisewait-0.1.0.dist-info/METADATA

@@ -0,0 +1,112 @@
+Metadata-Version: 2.1
+Name: optimisewait
+Version: 0.1.0
+Summary: A Python utility for automated image detection and clicking
+Home-page: https://github.com/yourusername/optimisewait
+Author: Alex M
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyautogui>=0.9.53
+
+# OptimiseWait
+
+A Python utility function for automated image detection and clicking using PyAutoGUI.
+
+## Installation
+
+```bash
+# Install from PyPI
+pip install optimisewait
+
+# Or install from source
+git clone https://github.com/yourusername/optimisewait.git
+cd optimisewait
+pip install .
+```
+
+## Quick Start
+
+```python
+from optimisewait import optimiseWait, set_autopath
+
+# Set default path for all subsequent optimiseWait calls
+set_autopath(r'D:\Images')
+
+# Basic usage - wait for image and click
+result = optimiseWait('button')  # Looks for button.png in D:\Images
+# Returns {'found': True, 'image': 'button'} if found
+```
+
+## Usage Examples
+
+```python
+# Override default path for specific call
+result = optimiseWait('button', autopath=r'D:\OtherImages')
+
+# Don't wait for image (check if image exists)
+result = optimiseWait('button', dontwait=True)
+# Returns {'found': False, 'image': None} if not found
+
+# Multiple click options
+optimiseWait('button', clicks=2)  # Double click
+optimiseWait('button', clicks=3)  # Triple click
+optimiseWait('button', clicks=0)  # No click, just wait for image
+
+# Multiple images to search for
+result = optimiseWait(['button', 'alt1', 'alt2'])  # Will click first image found
+# Returns {'found': True, 'image': 'alt1'} if alt1 was found first
+
+# Different clicks per image
+optimiseWait(['button', 'alt1', 'alt2'], clicks=[2, 3, 1])  # Different clicks per image
+
+# Offset clicking
+optimiseWait('button', xoff=10, yoff=20)  # Click 10px right, 20px down from center
+```
+
+## Functions
+
+### set_autopath(path)
+Sets the default path for image files that will be used by all subsequent optimiseWait calls.
+- `path`: String. Directory path where image files are located.
+
+### optimiseWait(filename, ...)
+Main function for image detection and clicking.
+
+## Parameters
+
+- `filename`: String or list of strings. Image filename(s) without .png extension
+- `dontwait`: Boolean (default False). If True, don't wait for image to appear
+- `specreg`: Tuple (default None). Specific region to search in (x, y, width, height)
+- `clicks`: Integer or list (default 1). Number of clicks per image (0 = no click, 1 = single, 2 = double, 3 = triple)
+- `xoff`: Integer (default 0). X offset from center for clicking
+- `yoff`: Integer (default 0). Y offset from center for clicking
+- `autopath`: String (optional). Directory containing image files. If not provided, uses path set by set_autopath()
+
+## Return Value
+
+Returns a dictionary with:
+- `found`: Boolean indicating if any image was found
+- `image`: String name of the found image, or None if no image was found
+
+## Notes
+
+- All image files should be PNG format
+- Images are searched with 90% confidence level
+- Function will wait indefinitely until image is found (unless dontwait=True)
+- When using multiple images, it will try each in order until one is found
+- If clicks is a single integer, it applies to the first found image (others default to 1 click)
+- If clicks is a list shorter than filename list, remaining images default to 1 click
+- Click offsets are calculated from the center of the found image
+- Default image path can be set once using set_autopath() and reused across multiple calls
+
+## Dependencies
+
+- PyAutoGUI >= 0.9.53
+
+## License
+
+MIT License

optimisewait-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+optimisewait/__init__.py,sha256=C9WfDggY86W8RuRWuZWbe4xmsIFYNhs2l_JxPq9nEYo,2184
+optimisewait-0.1.0.dist-info/LICENSE,sha256=tcT39tGBCeHTMvE5xATcYGe0sqX56uIpk0YzZU8Lb9w,1087
+optimisewait-0.1.0.dist-info/METADATA,sha256=u0me4Qi94Tu2o9tXj51eccYKS3KSfPsQ-3nVq6wIqNY,3810
+optimisewait-0.1.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+optimisewait-0.1.0.dist-info/top_level.txt,sha256=M9B9FIYnTW9ksN5-M4JEuGSnJ4twcSqL9PAeiEB2o5U,13
+optimisewait-0.1.0.dist-info/RECORD,,

optimisewait-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

optimisewait-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+optimisewait