Skip to main content

cmk-werk-zeug

Project description

CWZ - CMK-Werk-Zeug

This is both a collection of tools and shared libraries created for (but not limited to) Checkmk development and a 'collector' for other tools located in different repositories.

What you get

cmk-components

A CLI for querying and validating component and code ownership details of the check_mk (mostly) repository.

Use cases:

  • Browse all components interactively (TUI, default when no subcommand is given): tui
  • List all known components: list (alias: ls)
  • Show full details of one or more components: info [COMPONENT ...]
  • Show members/owners of a component: members [COMPONENT ...]
  • Show which paths belong to a component: paths <COMPONENT> [...]
  • Look up who owns a given file or directory: owners <PATH> [...]
  • Find which component a path belongs to: component <PATH> [...]
  • List all OWNERS config files in the repo: config-files
  • Show your own responsibilities (components and paths): my-responsibilities (alias: me)
  • Validate the code-owners configuration for consistency: validate-config

Credentials: resolved in folowing order:

  • ~/.netrc (looking for the hostname extracted from gerrit-url)
  • environment variables (via --gerrit-username-var / --gerrit-api-token-var).
  • GNOME keyring
  • interactive prompt (if not in dumb terminal mode), with option to store credentials in the keyring.

Source for ownership details: --gerrit-url, --project-name (defaults to check_mk), --branch (useful for change valildation) to point at a different Gerrit instance or branch.

Output modes (--mode): rich (default in a terminal), json, script (default when stdout is not a TTY — suitable for piping).

Caching (--cache-mode auto|always|never): a locally cached collection of component and ownership information stored at ~/.cache/cwz/cmk-components.json will be used in auto (default) mode if remote git commit still matches or when in always mode. In never mode, the cache will be ignored and updated with the latest data from Gerrit.

Install

You either clone the cwz repository (ssh://review.lan.tribe29.com:29418/cmk-werk-zeug) and make it's tools available via uv or you install the pip package:

pipx install cmk-werk-zeug

For ci_build_metrics you need PostgreSQL installed

sudo apt install postgresql postgresql-contrib postgresql-server-dev

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

cmk_werk_zeug-0.3.2.tar.gz (193.7 kB view details)

Uploaded Source

Built Distribution

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

cmk_werk_zeug-0.3.2-py3-none-any.whl (76.9 kB view details)

Uploaded Python 3

File details

Details for the file cmk_werk_zeug-0.3.2.tar.gz.

File metadata

  • Download URL: cmk_werk_zeug-0.3.2.tar.gz
  • Upload date:
  • Size: 193.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for cmk_werk_zeug-0.3.2.tar.gz
Algorithm Hash digest
SHA256 485e163ee7905193e32b564fa6df96fac694eecd8ddcc3d747380631da019d08
MD5 804a43475cffad62e19c2eeb0e33f7d9
BLAKE2b-256 eb3a91d1706370d782cfb145273306bffe57f903565923d7d91decac7471c1aa

See more details on using hashes here.

File details

Details for the file cmk_werk_zeug-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: cmk_werk_zeug-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 76.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for cmk_werk_zeug-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c79cefe217dfd0a4b110202a4c3fdcb71301153972c51075aa4c955b980202a8
MD5 dc2226d4eff9c7f26c9e2f7e147477f4
BLAKE2b-256 8d98fbe95328ae75df03de59ae1b1c48089d6b1e474e3a1ba2cca7d86e297508

See more details on using hashes here.

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