Skip to main content

Overview

Clicknium Python package supports automating various types of applications, such as Web browser, Windows application, Java application and SAP Windows GUI App, etc.

Install Clicknium Python pacakge

System Requirements​

  • Python 3.7 or above
  • Windows 7 SP1 or above

Install

pip install clicknium

API reference

  • Global Functions:the root level APIs for UI element.
  • UiElement: the UI element operations.
  • WebDriver: the web automation related objects and APIs.
  • Window: the window specific automation APIs.
  • SAP: the SAP specific automation APIs.
  • Java: the Java extension APIs.
  • Configuration: the configuration setting APIs.
  • Exceptions: the errors defined in clicknium.

Example

A sample code for web automation with clicknium is as follows.

from clicknium import clicknium as cc, locator, ui

# open new browser window
chrome_tab = cc.chrome.open("https://www.bing.com")
chrome_tab.find_element(locator.chrome.bing.search_sb_form_q).set_text("clicknium")
chrome_tab.find_element(locator.chrome.bing.svg).click()

# automation on already opened browser
chrome_tab = cc.chrome.attach_by_title_url(url="https://www.bing.com")
chrome_tab.find_element(locator.chrome.bing.search_sb_form_q).set_text("clicknium")
chrome_tab.find_element(locator.chrome.bing.svg).click()

# you can also use the following api directly, clicknium will automatically attach to the browser
ui(locator.chrome.bing.search_sb_form_q).set_text("clicknium")

# for Windows application
ui(locator.notepad.document_15).set_text("clicknium")