README.mdmarkdown
01awal
02
03A local README truth checker for fresh-clone developer onboarding.
04
05Install
06
07```bash
08pipx install git+https://github.com/mara-org/awal.git
09awal --help
10```
11
12Source
13
14Repository: https://github.com/mara-org/awal
15License: MIT
16 pyproject.tomltoml
01[project]
02name = "awal"
03description = "A local README truth checker for fresh-clone developer onboarding."
04requires-python = ">=3.9"
05license = { text = "MIT" }
06
07[project.scripts]
08awal = "awal.cli:main"
09 src/awal/cli.pypython
01from __future__ import annotations
02
03import argparse
04
05
06def build_parser() -> argparse.ArgumentParser:
07 parser = argparse.ArgumentParser(prog="awal")
08 parser.add_argument("path", nargs="?", default=".")
09 parser.add_argument("--format", choices=("text", "json"), default="text")
10 return parser
11
12
13def main(argv: list[str] | None = None) -> int:
14 args = build_parser().parse_args(argv)
15 print("awal", args.path, args.format)
16 return 0
17 tests/test_cli.pypython
01from awal.cli import main
02
03
04def test_main_smoke():
05 assert main(["."]) == 0
06