Skip to main content

Context-aware nickname autocomplete for ClickPLC instruction windows.

Project description

clicknick_logo

clicknick

Context-aware nickname autocomplete for ClickPLC instruction windows.

ClickNick demo

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

ClickNick App Main Window

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/11
  • CLICK Programming Software (tested on version 3.70)

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clicknick-0.9.3.tar.gz (83.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clicknick-0.9.3-py3-none-any.whl (49.8 kB view details)

Uploaded Python 3

File details

Details for the file clicknick-0.9.3.tar.gz.

File metadata

  • Download URL: clicknick-0.9.3.tar.gz
  • Upload date:
  • Size: 83.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for clicknick-0.9.3.tar.gz
Algorithm Hash digest
SHA256 a29e543d9a822c9f098a077d506456bdcfe32a95f8c4accdc5d0bf322db8d2ad
MD5 12ec4c383c2e8c6f1a0d7f3d699c860e
BLAKE2b-256 0f785fdf91448bd2eaa499f270c2c5e0f5a1688f9fc00b1ec886b971976d3243

See more details on using hashes here.

Provenance

The following attestation bundles were made for clicknick-0.9.3.tar.gz:

Publisher: publish.yml on ssweber/clicknick

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file clicknick-0.9.3-py3-none-any.whl.

File metadata

  • Download URL: clicknick-0.9.3-py3-none-any.whl
  • Upload date:
  • Size: 49.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for clicknick-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e54c0ad7ec2dd137c4fe6aabf33c5832aecce6410fc15fca383ffb40b65ea4c3
MD5 be6099157a48c1ed921893904e32ad08
BLAKE2b-256 d4976ac03ad41ccdb68b7573cbfda0af44b5cec18f3d0dbe31f243b8d9c86f55

See more details on using hashes here.

Provenance

The following attestation bundles were made for clicknick-0.9.3-py3-none-any.whl:

Publisher: publish.yml on ssweber/clicknick

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page