zmkfirmware / zmkfirmware/zmk-cli
Add periodic version check
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
To let users know when a new version of ZMK CLI is available, it would be helpful to add a check on startup that gets the latest version from PyPI and prints a message telling the user to update. If possible, we should detect whether ZMK CLI was installed with pip or pipx and print an appropriate upgrade command, e.g.
# pipx
pipx upgrade zmk
# pip
python3 -m pip install -U zmk
This check should only be run periodically, e.g. the first time the program is run each day, so we don't waste time repeatedly checking the version. There should also be a setting to disable this, and possibly one to adjust the time between checks.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or startup entry point are named. Trace the CLI startup path and existing settings, then determine how to query PyPI, identify pip versus pipx installation, and persist the check interval; done means a periodic opt-out-capable notification with an appropriate upgrade command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100