Clicknium extension for Visual Studio Code

Clicknium extension helps you implement automation for web and desktop applications easily in python.

• Capture UI locators easily by clicking the target UI element;
• Clicknium python module supports both web and desktop applications;
• Coding IntelliSense, Cloud locators, project management and more for higher efficiency.

Quick Setup

Go to extension's welcome page after installation by Clicknium:Welcome(Quick Setup), or follow below steps:

• System Requirement​

  • Windows 7 SP1 or above, windows 10 or 11 is recommended.
  • Python 3.7 or above is installed.

• Install Clicknium python module

pip install clicknium

• Sign into Clicknium

Sign in to Clicknium by clicking below button in LOCATORS tab (Google and GitHub accounts are supported):

Sample

• Open the Command Palette: Ctrl+Shift+P
• Input or select: Clicknium: Sample to select new folder or an existing folder

Then sample is created with a default locator store sample.

The sample.py contains two automation samples, one is Edge web automation, and the other is notepad automation.

import subprocess
from time import sleep
from clicknium import clicknium as cc, locator, ui

def main():
    # sample code to demo web automation and desktop application
    tab = cc.edge.open("https://www.bing.com/")
    tab.find_element(
        locator.sample.bing.search_sb_form_q).set_text('clicknium')
    tab.find_element(locator.sample.bing.svg).click()
    sleep(3)
    tab.close()

    process = subprocess.Popen("notepad")
    ui(locator.sample.notepad.document_15).set_text("clicknium")

if __name__ == "__main__":
    main()

Install and enable browser extension

• Click 'Clicknium Explorer' in Visual Studio Code Activity Bar
• Show 'AUTOMATION EXTENSIONS' view in Visual Studio Code Side Bar.
• Choose the Edge browser and click the 'install' button.
• After installation, you need to open Edge browser to enable 'Clicknium Recorder' extension.

Run/debug the sample

• Via Visual Studio Code built in commands:
  • F5 to debug sample.py
  • Ctrl+F5 to run sample.py

Record UI Locators

In Visual Studio Code, press Ctrl+F10 will invoke clicknium recorder and minimize current Visual Studio Code window.

After invoking Clicknium Recorder, you can move mouse on the target applicaiton, it will highlight the element recognized, if you want to capture the element, press Ctrl and click, the element locator will be added.

Edit and Validate Locator

After recording the locators, you can open and edit the locator

Clicknium Online Documents

For more about Clicknium, please ref to Online Document.

Contact US

Email to support@clicknium.com