wlkngkr 0.1.1

<|start_of_focus|># wlkngkr

wlkngkr is a modular, extensible environment probing framework. Each probe is a focused Python class, the runner orchestrates them, and the CLI produces structured pydantic reports that you can feed into logging, diagnostics, or compliance tooling.

Features

• Batteries-included probes for system and user context.
• Central registry + runner that selects probes by name or tag.
• Typed results (EnvReport, ProbeResult) built with pydantic.
• Typer-powered CLI that doubles as a Python API (ProbeRunner).
• Shipping via Apache 2.0 so it can live inside automation pipelines.

Installation

Stable releases will be published to PyPI.

pip install wlkngkr
# or, with uv (recommended for contributors)
uv tool install wlkngkr

If you want to work from the repo:

git clone https://github.com/cprima-forge/wlkngkr.git
cd wlkngkr
uv sync --dev

Usage

List available probes and run everything (default JSON output):

uv run wlkngkr --list
uv run wlkngkr --probe system --probe user

Prefer human-friendly status lines? Use the built-in text formatter:

uv run wlkngkr --format text
[system] status=success
[user]   status=success

Python API usage is equally straightforward:

from wlkngkr.runner import ProbeRunner
from wlkngkr.config import RunnerConfig

runner = ProbeRunner()
report = runner.run(RunnerConfig(tags=["core"]))
print(report.model_dump())

Development

uv sync --all-extras --dev
uv run pytest

Useful scripts:

• uv run wlkngkr run --probe system – run a single probe
• uv run wlkngkr --list – check registry state

Releasing

1. Update CHANGELOG.md and bump pyproject.toml's version.
2. Commit the release (git commit -am "chore: release v0.x.y").
3. Tag it (git tag v0.x.y && git push origin v0.x.y).
4. GitHub Actions (.github/workflows/release.yml) will run tests, build the distribution via uv build, and publish to PyPI. When a PYPI_API_TOKEN secret is present, the workflow uploads with twine>=6.1.0; otherwise it falls back to PyPI Trusted Publishing (OIDC).

License

Apache License 2.0 – see LICENSE.

Maintainer

Christian Prior-Mamulyan (@cprima) — cprior@gmail.com<|end_of_focus|>