Marka

Persistent browser highlights, numbered dots, labels and notes for explanatory screenshots.

English · Español

User guide ↗ · Keyword reference ↗ · PyPI ↗ · Live examples ↗

Install

pip install "robotframework-marka[robot]"

Python users can install robotframework-marka without the Robot adapter dependencies.

Annotate your existing browser

*** Settings ***
Library    SeleniumLibrary
Library    Marka

*** Test Cases ***
Show Changes
    Highlight Element    id:email    color=coral    background=rgba(240,100,69,0.12)    group=profile
    Add Dot    id:email    text=1    position=left    group=profile
    Add Note    id:save    text=Save changes    position=right    group=profile
    Capture Annotated Screenshot    ${OUTPUT DIR}/changes.png

from marka import Annotator
from selenium.webdriver.common.by import By

# driver is your existing Selenium WebDriver.
marks = Annotator(driver)
email = driver.find_element(By.ID, "email")
marks.add(email, color="coral", background="rgba(240,100,69,0.12)")
marks.add(email, kind="dot", text="1", color="#FFBF47", position="left")
marks.capture("output/changes.png")  # clears marks by default

Contributing

See CONTRIBUTING.md, CHANGELOG.md, and the development guide ↗.