plus3it / plus3it/watchmaker

Consider sub-commands for the watchmaker cli

Open
#1,041 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

release/1.0.0
Dominant language
Python
Stars
42
Forks
31
Avg merge
5h 22m
Merged PRs (30d)
19

Description

Right now, running watchmaker will immediately start executing. A safer default would be just to print the help. The current functionality could be implemented behind a sub-command, instead, e.g. watchmaker run. This would be introduced without changing the current behavior, just implementing the sub-command(s) and printing a deprecation warning when invoked without a sub-command.

Some sub-command ideas...

  • init - Copy config file to /etc/watchmaker.yaml or /etc/watchmaker/config.yaml
  • install - Invoke an install method from workers in the config, intended to install the config mgmt pkgs
  • run - Invoke the run method from workers, intended to run the config mgmt tool
  • clean - Invoke the clean method from workers, intended to remove config mgmt pkgs (not any hardening applied by the tool)
  • worker - Run a specific worker from the config

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the watchmaker CLI entry point and reviewing how the current no-subcommand invocation dispatches work. Define the intended subcommands and their behavior from the issue, then verify that the existing invocation remains functional while printing help for the safer default and a deprecation warning where required.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.