pyxelator 0.3.0

Image-based automation for Selenium, Playwright & Appium - locate elements by screenshots

Pyxelator

Pixel-based Element Locator for Web Automation

Visual element automation for Selenium & Playwright. No more XPath hunting - just use screenshots!

---

Why Pyxelator?

Traditional web automation requires finding elements by:

• XPath (breaks easily)
• CSS Selectors (tedious to write)
• IDs/Classes (may not exist)

With Pyxelator, you just need screenshots!

• Take screenshot of button/field
• Use it to find & interact
• Works with ANY element

---

Installation

pip install pyxelator

Requirements:

• Python 3.10+
• opencv-python
• numpy
• selenium or playwright

---

Quick Start

Super Simple API

from pyxelator import find, click, fill
from selenium import webdriver

driver = webdriver.Chrome()
driver.get('https://example.com')

# That's it! Just use images!
if find(driver, 'login_button.png'):
 click(driver, 'login_button.png')
 fill(driver, 'email_field.png', '[e-mail]')

Or use OOP style

from pyxelator import Pyxelator
from selenium import webdriver

driver = webdriver.Chrome()
driver.get('https://example.com')

px = Pyxelator(driver)

if px.find('login_button.png'):
 px.click('login_button.png')
 px.fill('email_field.png', '[e-mail]')

---

API Reference

Module Functions (Recommended)

find(driver, image, confidence=0.7)

Check if element exists.

if find(driver, 'button.png'):
 print("Button found!")

Parameters:

• driver - Selenium WebDriver or Playwright Page
• image - Path to template image
• confidence - Match confidence 0.0-1.0 (default: 0.7)

Returns: True if found, False otherwise

---

locate(driver, image, confidence=0.7)

Get element coordinates.

coords = locate(driver, 'button.png')
if coords:
 print(f"Button at {coords}") # (x, y)

Returns: (x, y) tuple or None

---

click(driver, image, confidence=0.7)

Click element by image.

click(driver, 'submit_button.png')

Returns: True if clicked, False if not found

---

fill(driver, image, text, confidence=0.7)

Fill text into element.

fill(driver, 'email_field.png', '[e-mail]')

Returns: True if filled, False if not found

---

Class API

Pyxelator(driver)

from pyxelator import Pyxelator

px = Pyxelator(driver)
px.find('button.png')
px.click('button.png')
px.fill('input.png', 'text')

Methods:

• find(image, confidence=0.7) bool
• locate(image, confidence=0.7) tuple or None
• click(image, confidence=0.7) bool
• fill(image, text, confidence=0.7) bool

---

Usage Examples

Selenium

from selenium import webdriver
from pyxelator import find, click, fill
import time

driver = webdriver.Chrome()
driver.get('https://example.com')
time.sleep(1)

# Login flow
if find(driver, 'login_button.png'):
 fill(driver, 'username.png', 'myuser')
 fill(driver, 'password.png', 'mypass')
 click(driver, 'submit.png')
 print("Logged in!")

driver.quit()

Playwright

from playwright.sync_api import sync_playwright
from pyxelator import find, click, fill
import time

with sync_playwright() as p:
 browser = p.chromium.launch(headless=False)
 page = browser.new_page()
 page.goto('https://example.com')
 time.sleep(1)

 # Same API!
 if find(page, 'login_button.png'):
 fill(page, 'username.png', 'myuser')
 fill(page, 'password.png', 'mypass')
 click(page, 'submit.png')
 print("Logged in!")

 browser.close()

Pytest Integration

import pytest
from selenium import webdriver
from pyxelator import find, click, fill
import time

@pytest.fixture
def driver():
 driver = webdriver.Chrome()
 driver.maximize_window()
 yield driver
 driver.quit()

def test_login(driver):
 driver.get('https://example.com')
 time.sleep(1)

 assert find(driver, 'login_button.png') == True
 assert click(driver, 'login_button.png') == True
 assert fill(driver, 'email.png', '[e-mail]') == True

---

Creating Template Images

Best Practices:

1. Screenshot ONE element (button, field, icon)
2. Keep it small (50x50 to 300x200 pixels)
3. Choose unique elements (avoid generic ones)
4. Crop tightly around the element
5. Use descriptive names (login_button.png, email_field.png)

How to Create:

# Helper script to create templates
from selenium import webdriver
import time

driver = webdriver.Chrome()
driver.get('https://yoursite.com')
time.sleep(2)

# Take full screenshot
driver.save_screenshot('fullpage.png')

# Now open fullpage.png in image editor
# Crop the specific element you want
# Save as: login_button.png, email_field.png, etc.

---

Confidence Levels

Adjust confidence parameter for matching accuracy:

# Strict matching (0.8-1.0)
find(driver, 'button.png', confidence=0.9)

# Balanced (0.7) - RECOMMENDED
find(driver, 'button.png', confidence=0.7)

# Relaxed (0.5-0.6)
find(driver, 'button.png', confidence=0.5)

Recommendation: Start with 0.7, adjust if needed.

---

Framework Compatibility

Selenium WebDriver - Fully supported Playwright - Fully supported Auto-detection - No configuration needed

Pyxelator automatically detects which framework you're using!

---

Troubleshooting

Element Not Found?

1. Check template size - Must be smaller than viewport
2. Lower confidence - Try confidence=0.6
3. Verify element visibility - Element must be on screen
4. Check template quality - Use clear screenshots

Click Not Working?

1. Verify element is clickable
2. Add delay before clicking - time.sleep(1)
3. Check if element is covered by other elements

Fill Not Working?

1. Ensure element is input field
2. Check if field needs to be focused first
3. Try clicking before filling

---

Advanced Usage

Multiple Actions

from pyxelator import Pyxelator

px = Pyxelator(driver)

# Chain actions
if px.find('login.png'):
 px.fill('email.png', '[e-mail]')
 px.fill('pass.png', '12345')
 px.click('submit.png')

Custom Confidence Per Element

# Strict for critical buttons
click(driver, 'delete_button.png', confidence=0.9)

# Relaxed for dynamic elements
fill(driver, 'search_box.png', 'query', confidence=0.6)

Error Handling

if not find(driver, 'button.png'):
 print("Button not found, taking alternative action...")
 # Fallback logic here

---

Testing

Run tests:

# Selenium tests
pytest test_pyxelator_selenium.py -v

# Playwright tests
pytest test_pyxelator_playwright.py -v

# All tests
pytest -v

---

Contributing

Contributions welcome! Please:

1. Fork the repository
2. Create feature branch
3. Add tests
4. Submit pull request

---

License

MIT License - see LICENSE file

---

Author

Created with for the automation community

---

Changelog

v0.1.0 (Initial Release)

• Selenium support
• Playwright support
• Auto framework detection
• Simple function API
• OOP class API
• Template matching with OpenCV
• Click, fill, find, locate actions

---

Support

• Issues: GitHub Issues
• Docs: Full Documentation
• Discussions: GitHub Discussions

---

**Happy Automating! **