clicknick

Context-aware nickname autocomplete for ClickPLC instruction windows.

Features

• Live Nicknames: Immediate access to Nicknames in your CLICK Programming Software, via ODBC connection.
• Smart Autocomplete: Shows only relevant nicknames based on the open instruction window.
• Multiple Filter Modes: Flexible search options:
  • Prefix: Match starting characters (e.g., "Val" → "Valve_1").
  • Contains: Find nicknames with any part of the text (e.g., "Run" → "Motor_Run").
  • Abbreviation: Supports two-way shorthand and multi-word matching (e.g., "Motor Speed" → "Mtr_Spd" or "MtrSpd" → "MotorSpeed").
• Helpful Tooltips: Displays address comments on hover for quick reference.
• Exclusion Filters:
  • Hide system addresses (SC/SD) to reduce clutter.
  • Exclude addresses based on custom naming conventions (e.g., omit nicknames containing double underscores __ if you use them for private or internal variables).
• Non-Intrusive: Works alongside Click PLC without modifications

How to Run

Note

For live nickname database functionality, you'll need Microsoft Access ODBC drivers installed. If you see an "ODBC drivers not found" warning, see our installation guide for help. CSV nickname file loading works without these drivers.

Option 1: Using uv (recommended)

Try it out:

uvx clicknick@latest

Install for offline use:

uv tool install clicknick

Run: clicknick (from command line or Start Menu)

Uninstall: uv tool uninstall clicknick
Upgrade: uv tool upgrade clicknick

If you don't have uv: https://github.com/astral-sh/uv#installation

Option 2: Using pip

pip install clicknick
python -m clicknick

Usage

1. Select your ClickPLC nickname CSV file
2. Connect to your Click PLC instance
3. Start monitoring
4. Open ClickPLC Instruction window and Type in added Combobox-Input to see autocomplete suggestions

Supported Windows

• Contact Normally Open/Closed
• Edge Contact
• Out, Set, Reset
• Compare (A with B)
• Timer, Counter
• Math instructions
• Shift Register
• Copy instruction
• Search instruction
• Search & Replace dialogs
• Data Views
• Address Picker Find

Requirements

• Windows 10 or 11
• CLICK Programming Software (v2.60 – v3.71).

---

Project Docs

For how to install uv and Python, see installation.md.

For development workflows, see development.md.

For instructions on publishing to PyPI, see publishing.md.

---

This project was built from simple-modern-uv.