Quick Start

Prerequisites #

System Requirements​

Main version
Python3.7, 3.8, 3.9, 3.10, 3.11
OSWindows 11, 10 recommended; Windows 7 SP1* or above

Note*: Windows 10 is the minimum supported Windows OS for DPI awareness.

Code Editor

  • Visual Studio Code

Installation​ #

Set Up Clicknium Visual Studio Code Extension

  1. Install the Extension (or search Clicknium in Visual Studio Code Extension marketplace).
  2. Click CLICKNIUM EXPLORER in Visual Studio Code Activity Bar
  3. Follow the welcome page:
    • Check the Python environment.
    • Install Clicknium Python module, as well as pip install clicknium
    • Select and install the browser extensions. Enable the extension after the installation.
    • Sign in to start for free.

To Reopen Welcome Page: open the Command Palette: Ctrl+Shift+P, input Clicknium:Welcome
To Enable Edge Extension: Open Edge browser, type edge://extensions/ into address bar and enable Clicknium Recorder extension as below: enable edge extension

Automation Sample #

Get a sample script showing automation of web page and notepad.

Setup Sample Project

  • Click Clicknium: Sample in Welcome Page. Or invoke the Command Palette by pressing Ctrl+Shift+P and input Clicknium: Sample.
  • Choose a path to locate sample project.

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/")

process = subprocess.Popen("notepad")

if __name__ == "__main__":

Run The Sample

In Visual Studio Code, open sample.py and press Ctrl+F5 to run the script with following steps:

  • Open a search engine page
  • Input a keyword and click search button
  • Open a notepad
  • Input text to notepad

Next #

Learn how to start an automation project from zero.

Document Guidelines #

For more about Clicknium Visual Studio Code, please refer to here.
You may need to refer Clicknium Python package documents when writing code.
For more tools provided by Clicknium, please refer to:

What are your feelings
Updated on 24 August 2023