crhelp 1.0.0__tar.gz

crhelp-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 crhelp contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

crhelp-1.0.0/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: crhelp
+Version: 1.0.0
+Summary: Cognitive Robotics Helper - Quick access to lab code snippets for Raspberry Pi, Arduino, ROS 2, and TurtleBot.
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Education
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# crhelp — Cognitive Robotics Helper
+
+A simple CLI tool to quickly view lab code snippets for Cognitive Robotics coursework.
+
+## Installation
+
+```bash
+pip install crhelp
+```
+
+## Usage
+
+```bash
+# List available code files
+crhelp list
+
+# View a specific file
+crhelp show allcodes
+crhelp show turtlecode
+
+# Check version
+crhelp --version
+```
+
+## Available Files
+
+| Name | Description |
+|------|-------------|
+| `allcodes` | Lab codes for Raspberry Pi, Arduino, Robo Car, and TurtleBot ROS 2 |
+| `turtlecode` | Multi-turtle ROS 2 controller (square + zigzag formations) |

crhelp-1.0.0/README.md

@@ -0,0 +1,30 @@
+# crhelp — Cognitive Robotics Helper
+
+A simple CLI tool to quickly view lab code snippets for Cognitive Robotics coursework.
+
+## Installation
+
+```bash
+pip install crhelp
+```
+
+## Usage
+
+```bash
+# List available code files
+crhelp list
+
+# View a specific file
+crhelp show allcodes
+crhelp show turtlecode
+
+# Check version
+crhelp --version
+```
+
+## Available Files
+
+| Name | Description |
+|------|-------------|
+| `allcodes` | Lab codes for Raspberry Pi, Arduino, Robo Car, and TurtleBot ROS 2 |
+| `turtlecode` | Multi-turtle ROS 2 controller (square + zigzag formations) |

crhelp-1.0.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "crhelp"
+version = "1.0.0"
+description = "Cognitive Robotics Helper - Quick access to lab code snippets for Raspberry Pi, Arduino, ROS 2, and TurtleBot."
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Education",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+
+[project.scripts]
+crhelp = "crhelp.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+crhelp = ["data/*.txt"]

crhelp-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

crhelp-1.0.0/src/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-1.0.0/src/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()