crhelp 1.0.0__py3-none-any.whl

crhelp/__init__.py

@@ -0,0 +1,6 @@
+"""crhelp - Cognitive Robotics Helper.
+
+Quick-access CLI to view lab code snippets for Cognitive Robotics coursework.
+"""
+
+__version__ = "1.0.0"

crhelp/cli.py

@@ -0,0 +1,85 @@
+"""Command-line interface for crhelp.
+
+Usage:
+    crhelp list                 List available code files.
+    crhelp show <name>          Display contents of a code file.
+    crhelp --version            Print version.
+"""
+
+import argparse
+import sys
+from pathlib import Path
+
+from crhelp import __version__
+
+# ---------------------------------------------------------------------------
+# Resolve the data directory bundled inside the installed package.
+# ---------------------------------------------------------------------------
+_DATA_DIR = Path(__file__).resolve().parent / "data"
+
+# Only the two original files are exposed.
+_AVAILABLE_FILES = {
+    "allcodes": _DATA_DIR / "allcodes.txt",
+    "turtlecode": _DATA_DIR / "turtlecode.txt",
+}
+
+
+def _cmd_list(args):
+    """Print the names of all available code files."""
+    print("Available files:")
+    for name in sorted(_AVAILABLE_FILES):
+        print(f"  {name}")
+
+
+def _cmd_show(args):
+    """Print the full contents of the requested file to stdout."""
+    name = args.name
+    if name not in _AVAILABLE_FILES:
+        print(f"Error: '{name}' is not a valid file name.", file=sys.stderr)
+        print(f"Run 'crhelp list' to see available files.", file=sys.stderr)
+        sys.exit(1)
+
+    filepath = _AVAILABLE_FILES[name]
+    if not filepath.exists():
+        print(f"Error: data file '{filepath}' not found.", file=sys.stderr)
+        sys.exit(1)
+
+    print(filepath.read_text(encoding="utf-8"))
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="crhelp",
+        description="Cognitive Robotics Helper - view lab code snippets.",
+    )
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {__version__}",
+    )
+
+    subparsers = parser.add_subparsers(dest="command")
+
+    # --- crhelp list ---
+    subparsers.add_parser("list", help="List available code files.")
+
+    # --- crhelp show <name> ---
+    show_parser = subparsers.add_parser("show", help="Display a code file.")
+    show_parser.add_argument(
+        "name",
+        help="Name of the file to display (e.g. allcodes, turtlecode).",
+    )
+
+    args = parser.parse_args()
+
+    if args.command == "list":
+        _cmd_list(args)
+    elif args.command == "show":
+        _cmd_show(args)
+    else:
+        parser.print_help()
+        sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()