pio-robo 0.1.0__tar.gz

pio_robo-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2026] [Edward Withers]
+
+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.

pio_robo-0.1.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: pio-robo
+Version: 0.1.0
+Summary: A simple grid-based robot programming environment for teaching Python functions-first.
+Author: Edward Withers
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Education
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: student
+Requires-Dist: pytest<10,>=8; extra == "student"
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=8; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# 🤖 Robo – Classroom Programming Environment
+
+A simple Python-based learning environment for teaching programming functions-first through grid-based robot challenges.
+
+## Setup
+
+### Install from PyPI
+
+```bash
+pip install robo
+```
+
+### Development install
+
+```bash
+git clone <repo>
+cd robo
+pip install -e .
+```
+
+## Run a world
+
+From a student project folder:
+
+```bash
+python -m robo world1.0
+```
+
+Student solution files live in:
+
+```text
+exercises/
+  world1_0.py
+```
+
+## Check progress
+
+```bash
+python -m robo summary
+```
+
+## Run tests
+
+From the project root:
+
+```bash
+python -m pytest
+```
+
+Run tests when you:
+
+- add new worlds
+- change commands
+- change runner/display behaviour
+
+## Contribute
+
+1. Create or edit code.
+2. Run the test suite.
+3. Check that student worlds still run.
+4. Open a pull request.
+
+See the `docs/` folder for pupil-facing command guides and teacher/developer notes.

pio_robo-0.1.0/README.md

@@ -0,0 +1,63 @@
+# 🤖 Robo – Classroom Programming Environment
+
+A simple Python-based learning environment for teaching programming functions-first through grid-based robot challenges.
+
+## Setup
+
+### Install from PyPI
+
+```bash
+pip install robo
+```
+
+### Development install
+
+```bash
+git clone <repo>
+cd robo
+pip install -e .
+```
+
+## Run a world
+
+From a student project folder:
+
+```bash
+python -m robo world1.0
+```
+
+Student solution files live in:
+
+```text
+exercises/
+  world1_0.py
+```
+
+## Check progress
+
+```bash
+python -m robo summary
+```
+
+## Run tests
+
+From the project root:
+
+```bash
+python -m pytest
+```
+
+Run tests when you:
+
+- add new worlds
+- change commands
+- change runner/display behaviour
+
+## Contribute
+
+1. Create or edit code.
+2. Run the test suite.
+3. Check that student worlds still run.
+4. Open a pull request.
+
+See the `docs/` folder for pupil-facing command guides and teacher/developer notes.

pio_robo-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pio-robo"
+version = "0.1.0"
+description = "A simple grid-based robot programming environment for teaching Python functions-first."
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [
+    { name = "Edward Withers" }
+]
+license = { text = "MIT" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Intended Audience :: Education",
+    "Topic :: Education",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+
+[project.optional-dependencies]
+student = [
+    "pytest>=8,<10",
+]
+
+dev = [
+    "pytest>=8,<10",
+    "build",
+    "twine",
+]
+
+[project.scripts]
+robo = "robo.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"robo.templates" = ["README.md", "exercises/*.py"]

pio_robo-0.1.0/setup.cfg

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

pio_robo-0.1.0/src/pio_robo.egg-info/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: pio-robo
+Version: 0.1.0
+Summary: A simple grid-based robot programming environment for teaching Python functions-first.
+Author: Edward Withers
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Education
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: student
+Requires-Dist: pytest<10,>=8; extra == "student"
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=8; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# 🤖 Robo – Classroom Programming Environment
+
+A simple Python-based learning environment for teaching programming functions-first through grid-based robot challenges.
+
+## Setup
+
+### Install from PyPI
+
+```bash
+pip install robo
+```
+
+### Development install
+
+```bash
+git clone <repo>
+cd robo
+pip install -e .
+```
+
+## Run a world
+
+From a student project folder:
+
+```bash
+python -m robo world1.0
+```
+
+Student solution files live in:
+
+```text
+exercises/
+  world1_0.py
+```
+
+## Check progress
+
+```bash
+python -m robo summary
+```
+
+## Run tests
+
+From the project root:
+
+```bash
+python -m pytest
+```
+
+Run tests when you:
+
+- add new worlds
+- change commands
+- change runner/display behaviour
+
+## Contribute
+
+1. Create or edit code.
+2. Run the test suite.
+3. Check that student worlds still run.
+4. Open a pull request.
+
+See the `docs/` folder for pupil-facing command guides and teacher/developer notes.

pio_robo-0.1.0/src/pio_robo.egg-info/SOURCES.txt

@@ -0,0 +1,71 @@
+LICENSE
+README.md
+pyproject.toml
+src/pio_robo.egg-info/PKG-INFO
+src/pio_robo.egg-info/SOURCES.txt
+src/pio_robo.egg-info/dependency_links.txt
+src/pio_robo.egg-info/entry_points.txt
+src/pio_robo.egg-info/requires.txt
+src/pio_robo.egg-info/top_level.txt
+src/robo/__init__.py
+src/robo/__main__.py
+src/robo/cli.py
+src/robo/commands.py
+src/robo/project.py
+src/robo/run.py
+src/robo/world_tools.py
+src/robo/solutions/__init__.py
+src/robo/solutions/world1_0.py
+src/robo/solutions/world1_1.py
+src/robo/solutions/world1_2.py
+src/robo/solutions/world1_3.py
+src/robo/solutions/world1_4.py
+src/robo/solutions/world1_5.py
+src/robo/solutions/world1_6.py
+src/robo/solutions/world1_7.py
+src/robo/solutions/world1_8.py
+src/robo/solutions/world1_9.py
+src/robo/solutions/world2_0.py
+src/robo/solutions/world2_1.py
+src/robo/teacher_solutions/__init__.py
+src/robo/teacher_solutions/world1_0.py
+src/robo/teacher_solutions/world1_1.py
+src/robo/teacher_solutions/world1_2.py
+src/robo/teacher_solutions/world1_3.py
+src/robo/teacher_solutions/world1_4.py
+src/robo/teacher_solutions/world1_5.py
+src/robo/teacher_solutions/world1_6.py
+src/robo/teacher_solutions/world1_7.py
+src/robo/teacher_solutions/world1_8.py
+src/robo/teacher_solutions/world1_9.py
+src/robo/teacher_solutions/world2_0.py
+src/robo/teacher_solutions/world2_1.py
+src/robo/templates/__init__.py
+src/robo/templates/exercises/world1_0.py
+src/robo/templates/exercises/world1_1.py
+src/robo/templates/exercises/world1_2.py
+src/robo/templates/exercises/world1_3.py
+src/robo/templates/exercises/world1_4.py
+src/robo/templates/exercises/world1_5.py
+src/robo/templates/exercises/world1_6.py
+src/robo/templates/exercises/world1_7.py
+src/robo/templates/exercises/world1_8.py
+src/robo/templates/exercises/world1_9.py
+src/robo/templates/exercises/world2_0.py
+src/robo/templates/exercises/world2_1.py
+src/robo/worlds/__init__.py
+src/robo/worlds/world1_0.py
+src/robo/worlds/world1_1.py
+src/robo/worlds/world1_2.py
+src/robo/worlds/world1_3.py
+src/robo/worlds/world1_4.py
+src/robo/worlds/world1_5.py
+src/robo/worlds/world1_6.py
+src/robo/worlds/world1_7.py
+src/robo/worlds/world1_8.py
+src/robo/worlds/world1_9.py
+src/robo/worlds/world2_0.py
+src/robo/worlds/world2_1.py
+tests/test_commands.py
+tests/test_display.py
+tests/test_runner.py

pio_robo-0.1.0/src/pio_robo.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pio_robo-0.1.0/src/pio_robo.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+robo = robo.cli:main

pio_robo-0.1.0/src/pio_robo.egg-info/requires.txt

@@ -0,0 +1,8 @@
+
+[dev]
+pytest<10,>=8
+build
+twine
+
+[student]
+pytest<10,>=8

pio_robo-0.1.0/src/pio_robo.egg-info/top_level.txt

@@ -0,0 +1 @@
+robo

pio_robo-0.1.0/src/robo/__init__.py

@@ -0,0 +1 @@
+# Robo package

pio_robo-0.1.0/src/robo/__main__.py

@@ -0,0 +1,4 @@
+from robo.cli import main
+
+if __name__ == "__main__":
+    main()

pio_robo-0.1.0/src/robo/cli.py

@@ -0,0 +1,115 @@
+import argparse
+from pathlib import Path
+
+from robo.project import create_project
+from robo.run import run_world, show_summary
+from robo.world_tools import (
+    create_world_from_template,
+    delete_world,
+    list_world_files,
+)
+
+
+def build_parser():
+    parser = argparse.ArgumentParser(
+        prog="robo",
+        description="Robo: a simple grid-based Python teaching tool."
+    )
+
+    subparsers = parser.add_subparsers(
+        dest="command",
+        required=True
+    )
+
+    new_parser = subparsers.add_parser(
+        "new",
+        help="Create a new student project."
+    )
+    new_parser.add_argument(
+        "project_name",
+        help="Name of the student project folder to create."
+    )
+
+    run_parser = subparsers.add_parser(
+        "run",
+        help="Run one world from the current student project."
+    )
+
+    run_parser.add_argument(
+        "world_name",
+        help="World to run, e.g. world1.0"
+    )
+
+    subparsers.add_parser(
+        "summary",
+        help="Show which worlds are completed in the current student project."
+    )
+
+    make_world_parser = subparsers.add_parser(
+        "make-world",
+        help="Create the next world from scripts/new_world.py."
+    )
+    make_world_parser.add_argument(
+        "--name",
+        help="Optional world name, e.g. world2.0. If omitted, the next number is used."
+    )
+    make_world_parser.add_argument(
+        "--overwrite",
+        action="store_true",
+        help="Overwrite files if this world already exists."
+    )
+
+    delete_world_parser = subparsers.add_parser(
+        "delete-world",
+        help="Delete generated files for a world."
+    )
+    delete_world_parser.add_argument(
+        "--name",
+        required=True,
+        help="World name to delete, e.g. world2.0"
+    )
+    delete_world_parser.add_argument(
+        "--dry-run",
+        action="store_true",
+        help="Show what would be deleted without deleting files."
+    )
+
+    subparsers.add_parser(
+        "list-worlds",
+        help="List worlds in the package."
+    )
+
+    return parser
+
+
+def main():
+    parser = build_parser()
+    args = parser.parse_args()
+
+    if args.command == "new":
+        create_project(args.project_name)
+
+    elif args.command == "run":
+        run_world(args.world_name, Path.cwd())
+
+    elif args.command == "summary":
+        show_summary(Path.cwd())
+
+    elif args.command == "make-world":
+        create_world_from_template(
+            overwrite=args.overwrite,
+            world_name=args.name
+        )
+
+    elif args.command == "delete-world":
+        delete_world(
+            world_name=args.name,
+            dry_run=args.dry_run
+        )
+
+    elif args.command == "list-worlds":
+        list_world_files()
+
+
+if __name__ == "__main__":
+    main()

pio_robo-0.1.0/src/robo/commands.py

@@ -0,0 +1,178 @@
+world = None
+robo = None
+trail = []
+
+def load_world(w, r):
+    global world, robo, trail
+    world = w
+    robo = r
+    trail = [(robo["x"], robo["y"])]
+
+def move():
+    x = robo["x"]
+    y = robo["y"]
+    d = robo["direction"]
+
+    if d == "N":
+        new_x, new_y = x, y + 1
+    elif d == "E":
+        new_x, new_y = x + 1, y
+    elif d == "S":
+        new_x, new_y = x, y - 1
+    elif d == "W":
+        new_x, new_y = x - 1, y
+
+    if not (0 <= new_x < 5 and 0 <= new_y < 5):
+        raise Exception("🚧 Can't leave the grid!")
+
+    if world[new_y][new_x] in ["|", "-"]:
+        raise Exception("⛔ Hit a wall!")
+
+    robo["x"] = new_x
+    robo["y"] = new_y
+    trail.append((new_x, new_y))
+    print("➡️ move")
+
+def turn_left():
+    directions = ["N", "W", "S", "E"]
+    robo["direction"] = directions[(directions.index(robo["direction"]) + 1) % 4]
+    print("↩️ turn left")
+
+def turn_right():
+    directions = ["N", "E", "S", "W"]
+    robo["direction"] = directions[(directions.index(robo["direction"]) + 1) % 4]
+    print("↪️ turn right")
+
+def get_star():
+    x, y = robo["x"], robo["y"]
+
+    if world[y][x] == "⭐":
+        world[y][x] = "."
+        print("⭐ picked up")
+    else:
+        raise Exception("❌ No star here!")
+
+def place_star():
+    x, y = robo["x"], robo["y"]
+
+    if world[y][x] == ".":
+        world[y][x] = "⭐"
+        print("⭐ placed")
+    else:
+        raise Exception("❌ Can't place star here!")
+
+def get_position_in_front():
+    x = robo["x"]
+    y = robo["y"]
+    d = robo["direction"]
+
+    if d == "N":
+        return x, y + 1
+    elif d == "E":
+        return x + 1, y
+    elif d == "S":
+        return x, y - 1
+    elif d == "W":
+        return x - 1, y
+
+def is_inside_grid(x, y):
+    return 0 <= x < 5 and 0 <= y < 5
+
+def wall_ahead():
+    x, y = get_position_in_front()
+
+    if not is_inside_grid(x, y):
+        return True
+
+    return world[y][x] in ["|", "-"]
+
+def can_move():
+    return not wall_ahead()
+
+def star_here():
+    x = robo["x"]
+    y = robo["y"]
+
+    return world[y][x] == "⭐"
+
+def star_ahead():
+    x, y = get_position_in_front()
+
+    if not is_inside_grid(x, y):
+        return False
+
+    return world[y][x] == "⭐"
+
+def facing_north():
+    return robo["direction"] == "N"
+
+def facing_east():
+    return robo["direction"] == "E"
+
+def facing_south():
+    return robo["direction"] == "S"
+
+def facing_west():
+    return robo["direction"] == "W"
+
+# Pupil-friendly aliases for grid directions
+
+def facing_up():
+    return facing_north()
+
+def facing_right():
+    return facing_east()
+
+def facing_down():
+    return facing_south()
+
+def facing_left():
+    return facing_west()
+
+def show_world():
+    print("\n🌍 WORLD")
+
+    for y in reversed(range(5)):
+        row = ""
+        for x in range(5):
+
+            # Determine cell content
+            if x == robo["x"] and y == robo["y"]:
+                cell = "🤖"
+            else:
+                cell = world[y][x]
+
+            # Pad NON-emoji cells
+            if cell in [".", "|", "-"]:
+                cell = cell + " "   # make it width ~2
+            # emoji left as-is
+
+            row += cell + " "
+
+        print(row)
+
+    print(f"\n🧭 Facing: {robo['direction']}\n")
+
+
+
+def show_custom_world(world_data, robo_data):
+    print("\n🌍 TARGET")
+
+    for y in reversed(range(5)):
+        row = ""
+        for x in range(5):
+            if x == robo_data["x"] and y == robo_data["y"]:
+                cell = "🤖"
+            else:
+                cell = world_data[y][x]
+
+            if cell in [".", "|", "-"]:
+                cell = cell + " "
+
+            row += cell + " "
+
+        print(row)
+
+    print(f"\n🧭 Facing: {robo_data['direction']}\n")
+
+