rigyard 1.0.0__tar.gz

rigyard-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,87 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install -e '.[dev]'
+      - run: pytest --cov=rigyard --cov-report=term-missing --cov-fail-under=90
+      - run: ruff check .
+      - run: ruff format --check .
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - run: python -m pip install -e '.[dev]'
+      - run: mypy src/rigyard
+      - run: pyright src/rigyard
+
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - run: python -m pip install build twine
+      - run: python -m build
+      - run: python -m twine check --strict dist/*
+      - run: python scripts/verify_distributions.py dist
+      - run: |
+          for format in wheel sdist; do
+            python -m venv "$RUNNER_TEMP/rigyard-$format"
+            artifact=(dist/*.whl)
+            if [[ "$format" == sdist ]]; then
+              artifact=(dist/*.tar.gz)
+            fi
+            "$RUNNER_TEMP/rigyard-$format/bin/python" -m pip install "${artifact[0]}"
+            (
+              cd "$RUNNER_TEMP"
+              "$RUNNER_TEMP/rigyard-$format/bin/rigyard" --version
+              "$RUNNER_TEMP/rigyard-$format/bin/rigyard" --help >/dev/null
+              "$RUNNER_TEMP/rigyard-$format/bin/rigyard" \
+                --config "$GITHUB_WORKSPACE/examples/minimal/rigyard.yaml" validate
+            )
+          done
+        shell: bash
+      - uses: actions/upload-artifact@v5
+        with:
+          name: python-distributions
+          path: dist/
+          if-no-files-found: error
+
+  docker-smoke:
+    needs: package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+      - uses: actions/download-artifact@v6
+        with:
+          name: python-distributions
+          path: dist/
+      - run: python -m pip install dist/*.whl
+      - run: sudo apt-get update && sudo apt-get install -y tmux
+      - run: docker info && docker compose version && tmux -V
+      - run: bash tests/integration/smoke.sh

rigyard-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,107 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pypi-${{ github.event.release.tag_name }}
+  cancel-in-progress: false
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ github.event.release.tag_name }}
+          persist-credentials: false
+      - uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install -e '.[dev]'
+      - run: pytest --cov=rigyard --cov-report=term-missing --cov-fail-under=90
+      - run: ruff check . && ruff format --check .
+      - if: matrix.python-version == '3.12'
+        run: mypy src/rigyard && pyright src/rigyard
+
+  build:
+    needs: verify
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ github.event.release.tag_name }}
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+      - name: Ensure this Release comes from main
+        run: |
+          git fetch origin main
+          git merge-base --is-ancestor HEAD origin/main
+      - run: python -m pip install build twine
+      - run: python -m build
+      - run: python -m twine check --strict dist/*
+      - name: Verify distribution contents and Release version
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: python scripts/verify_distributions.py dist --tag "$RELEASE_TAG"
+      - name: Install and validate the release wheel
+        run: |
+          python -m venv "$RUNNER_TEMP/rigyard-release"
+          "$RUNNER_TEMP/rigyard-release/bin/python" -m pip install dist/*.whl
+          (
+            cd "$RUNNER_TEMP"
+            "$RUNNER_TEMP/rigyard-release/bin/rigyard" --version
+            "$RUNNER_TEMP/rigyard-release/bin/rigyard" \
+              --config "$GITHUB_WORKSPACE/examples/minimal/rigyard.yaml" validate
+          )
+      - uses: actions/upload-artifact@v5
+        with:
+          name: python-distributions
+          path: dist/
+          if-no-files-found: error
+
+  docker-smoke:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ github.event.release.tag_name }}
+          persist-credentials: false
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+      - uses: actions/download-artifact@v6
+        with:
+          name: python-distributions
+          path: dist/
+      - run: python -m pip install dist/*.whl
+      - run: sudo apt-get update && sudo apt-get install -y tmux
+      - run: docker info && docker compose version && tmux -V
+      - run: bash tests/integration/smoke.sh
+
+  publish:
+    needs: docker-smoke
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/rigyard/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          name: python-distributions
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

rigyard-1.0.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+.venv/
+dist/
+build/
+
+.rigyard/runs/

rigyard-1.0.0/CHANGELOG.md

@@ -0,0 +1,75 @@
+# Changelog
+
+This file records notable user-facing changes. Releases use semantic versioning and group entries under Added, Changed, Fixed, and Breaking Changes.
+
+## Unreleased
+
+## 1.0.0 - 2026-09-25
+
+### Added
+
+- A Bash bootstrap script that installs uv and a managed Python environment, plus a script to activate it in new shells.
+- A GitHub Release workflow that verifies distributions and publishes to PyPI through trusted publishing.
+- Source-qualified definition catalog and `inspect/resolve --source` for ambiguous resources.
+- Private, atomic scenario run records for controlling the original runtime after configuration changes.
+- Injectable scenario runtime ports and separate startup/control plan models.
+
+- Structured user documentation for configuration, templates, runtime values, and core features.
+- Python-environment command aliases through `rigyard init --alias NAME`.
+- User-defined test run and result-reporting commands through `rigyard test run` and
+  `rigyard test report`.
+- Constrained project-specific container tasks through `rigyard task run` and the fixed
+  configuration-driven Tasks menu.
+- Manifest-configured workspace command aliases with CLI override and opt-out controls.
+- Terminal logos loaded from external UTF-8 files through templated paths.
+- Safe, project-aware alias removal through `rigyard alias remove`.
+- Prompt-local `${INPUT}` composition and explicit list append semantics for runtime values.
+- Image build network modes, per-layer overrides, and an atomic interactive host-proxy group.
+- Source-aware `${SOURCE_DIR}` and `${SOURCE_FILE}` templates, plus `${RIGYARD_FILE}` for the
+  absolute root manifest path.
+
+### Changed
+
+- Workspace command aliases discover the closest workspace in the current or parent directories at execution time.
+- Configuration models and request overrides now freeze nested collections; serialization returns ordinary values.
+- Build, test, and task use cases invoke their backends directly instead of forwarding through empty services.
+
+- Generated tmux sessions, Compose projects, and pane metadata now use the `rigyard` prefix.
+- CI now covers Python 3.10 through 3.13, enforces test coverage, and validates built wheel and
+  source-distribution artifacts.
+- Package metadata now reads its version exclusively from `src/rigyard/version.py`.
+- Complete Compose scene starts now remove the previous project containers and orphans before
+  recreating them; partial instance starts remain incremental.
+- Build, test, and custom-task commands now start stopped target containers by default, with
+  `start_container: false` available for strict lifecycle ownership.
+- Reduced the README to a PyPI-friendly overview and quick start.
+- Split repository examples into a minimal introduction and a full robot-development reference.
+- Standardized all project documentation and internal comments on English.
+- Renamed the project, distribution, Python package, CLI, configuration contract, workspace state,
+  generated identifiers, examples, and documentation from Toolchain to Rigyard.
+
+### Fixed
+
+- Interrupting build, test, and task commands stops their processes inside the container.
+- Workspace configuration resolution follows the nearest manifest instead of retaining stale initialization state.
+- Explicit overrides for prompts in a selected secondary source with a duplicate resource name.
+- Scenario instance selection no longer resolves prompts belonging to unselected or disabled instances.
+- `scene status --instance` now restricts the queried windows.
+- String boolean enable values are validated instead of interpreted by Python truthiness.
+
+
+### Breaking changes
+
+- Generated scenario runtime names now include both the source file and profile, using the same identity for tmux and Compose. Stop/remove legacy runtime resources with the previous version before upgrading.
+- Project-wide parameter inspection/resolution now rejects duplicate names unless `--source` selects a source.
+- Internal build/test/task forwarding service modules have been removed; use application use cases or backend protocols.
+
+- The command is now `rigyard`, the default manifest is `rigyard.yaml`, and workspace state lives
+  in `.rigyard/context.yaml`.
+- `${TOOLCHAIN_ROOT}` is now `${RIGYARD_ROOT}`, and `TOOL_PARAM_*` overrides are now
+  `RIGYARD_PARAM_*`.
+- The import package and distribution name are now `rigyard`.
+- Removed compatibility fallbacks for assembled configurations without source provenance,
+  schema version 2 migration guidance, and the old Docker runner import path.
+- Removed the ineffective scenario `replace` profile field and `--replace` CLI option;
+  scenario starts always replace matching tmux state.

rigyard-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+
+## Development environment
+
+The project requires Python 3.10 or newer. The recommended setup uses uv:
+
+```bash
+uv sync --extra dev
+```
+
+Alternatively, use a standard virtual environment:
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+python -m pip install -e '.[dev]'
+```
+
+## Checks
+
+Run these checks before submitting a change:
+
+```bash
+python -m ruff check .
+python -m ruff format --check .
+python -m mypy src/rigyard
+python -m pyright src/rigyard
+python -m pytest
+python -m pip install build twine
+python -m build
+python -m twine check dist/*
+```
+
+Documentation examples must match the current schema and CLI. When changing configuration models, defaults, or command arguments, update `docs/reference/configuration-schema.md`, the relevant feature guide, and the example configuration.
+
+## Code boundaries
+
+- `config` loads manifest and source files and reports source locations.
+- `parameters` resolves runtime values and string templates.
+- `images`, `containers`, `builds`, and `scenarios` create immutable plans before invoking an executor.
+- The CLI and interactive menu share application use cases.
+
+See the [architecture guide](docs/development/architecture.md) for more detail.

rigyard-1.0.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 zz990099
+
+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.
+

rigyard-1.0.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.5
+Name: rigyard
+Version: 1.0.0
+Summary: A configuration-driven CLI for containerized development workflows
+Project-URL: Documentation, https://github.com/zz990099/Rigyard/tree/main/docs
+Project-URL: Issues, https://github.com/zz990099/Rigyard/issues
+Project-URL: Repository, https://github.com/zz990099/Rigyard
+Author: zz990099
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.10
+Requires-Dist: pydantic<3,>=2.6
+Requires-Dist: pyyaml<7,>=6.0
+Provides-Extra: dev
+Requires-Dist: mypy<2,>=1.11; extra == 'dev'
+Requires-Dist: pyright<2,>=1.1; extra == 'dev'
+Requires-Dist: pytest-cov<7,>=5; extra == 'dev'
+Requires-Dist: pytest<9,>=8; extra == 'dev'
+Requires-Dist: ruff<1,>=0.6; extra == 'dev'
+Requires-Dist: types-pyyaml<7,>=6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Rigyard
+
+Rigyard is a configuration-driven CLI for containerized robotics development. A single project manifest organizes layered image builds, development containers, project builds and tests inside containers, project-specific tasks, and multi-process debugging scenarios managed by tmux.
+
+## Features
+
+- Build layered images from ordered Dockerfile fragments.
+- Create reproducible development containers and run lifecycle hooks.
+- Run project build scripts inside existing containers, starting stopped containers when allowed.
+- Run user-defined test and test-result commands with the same configurable start behavior.
+- Expose constrained project-specific container tasks through the CLI and interactive menu.
+- Start tmux debugging scenarios in existing containers or Docker Compose services.
+- Reuse configuration with global variables, string templates, and interactive runtime values.
+- Use the same application behavior through direct commands or a branded one-shot interactive menu.
+
+## Requirements
+
+- Linux and Bash for the setup script; it installs Python 3.12 and Rigyard using uv
+- Docker for container operations; Compose scenarios require Docker Compose v2
+- Scenario support requires tmux on the host and an interactive shell in each target container
+
+## Installation
+
+Clone the repository, run the host setup, and activate the shared Rigyard environment:
+
+```bash
+git clone https://github.com/zz990099/Rigyard.git
+cd Rigyard
+bash scripts/bootstrap.sh
+source scripts/activate.sh
+rigyard --version
+```
+
+The script installs uv if needed and creates a Python environment without requiring Conda or a
+preinstalled Python. Source `scripts/activate.sh` in each new terminal. Docker, Compose, and tmux
+are checked but installed separately when needed. See [installation and requirements](https://github.com/zz990099/Rigyard/blob/main/docs/installation.md)
+for setup details, manual Conda installation, and troubleshooting. See the
+[contribution guide](https://github.com/zz990099/Rigyard/blob/main/CONTRIBUTING.md) for development checks.
+
+For a CLI-only installation without a repository checkout, use
+`uv tool install --python 3.12 rigyard`. The Bash setup and activation scripts above belong to
+the checkout.
+
+## Quick start
+
+By default, Rigyard reads `rigyard.yaml` from the current directory:
+
+```yaml
+version: 3
+
+metadata:
+  name: robot-development
+
+workspace:
+  command_alias: robot
+
+variables:
+  PROJECT_ROOT: ${RIGYARD_ROOT}
+  BRANDING_ROOT: ${PROJECT_ROOT}/branding
+  CONTAINER_WORKSPACE_ROOT: /workspace
+
+branding:
+  logo_file: ${BRANDING_ROOT}/logo.txt
+
+sources:
+  images: [config/images.yaml]
+  containers: [config/containers.yaml]
+  builds: [config/builds.yaml]
+  tests: [config/tests.yaml]
+  tasks: [config/tasks.yaml]
+  scenarios: [config/scenarios.yaml]
+```
+
+Validate the configuration and run configured operations:
+
+```bash
+rigyard validate
+rigyard image build development
+rigyard container create development
+rigyard build native
+rigyard test run unit
+rigyard test report unit
+rigyard task run clean
+rigyard scene start robot-system development
+```
+
+Run `rigyard` without a subcommand to open the one-shot interactive menu:
+
+```bash
+rigyard
+```
+
+With the built-in logo and the example sources configured, the menu looks like this (colours omitted):
+
+```text
+$ rigyard
+██████╗ ██╗ ██████╗ ██╗   ██╗ █████╗ ██████╗ ██████╗
+██╔══██╗██║██╔════╝ ╚██╗ ██╔╝██╔══██╗██╔══██╗██╔══██╗
+██████╔╝██║██║  ███╗ ╚████╔╝ ███████║██████╔╝██║  ██║
+██╔══██╗██║██║   ██║  ╚██╔╝  ██╔══██║██╔══██╗██║  ██║
+██║  ██║██║╚██████╔╝   ██║   ██║  ██║██║  ██║██████╔╝
+╚═╝  ╚═╝╚═╝ ╚═════╝    ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═════╝
+
+Project: robot-development
+Configuration: /workspace/robot-development/rigyard.yaml
+
+1) Build image
+2) Create container
+3) Build project
+4) Scene…
+5) Test…
+6) Tasks…
+0) Exit
+Select [0-6]:
+```
+
+Custom terminal logos can be inline or loaded from a templated path; see the [root manifest guide](https://github.com/zz990099/Rigyard/blob/main/docs/configuration/manifest.md#terminal-logo).
+
+When the manifest lives elsewhere, pass it explicitly or bind the current workspace:
+
+```bash
+rigyard --config path/to/rigyard.yaml validate
+rigyard init -f path/to/rigyard.yaml
+robot build native
+```
+
+Configured aliases are installed in the active Conda or virtual environment. They are generic
+commands that discover the nearest current-or-parent workspace at runtime, so the same alias can be
+shared by multiple workspaces. They can be removed with `rigyard alias remove`.
+
+## Documentation
+
+- [Getting started](https://github.com/zz990099/Rigyard/blob/main/docs/getting-started.md)
+- [Installation and requirements](https://github.com/zz990099/Rigyard/blob/main/docs/installation.md)
+- [Configuration overview](https://github.com/zz990099/Rigyard/blob/main/docs/configuration/index.md)
+- [Global variables and string templates](https://github.com/zz990099/Rigyard/blob/main/docs/configuration/templates.md)
+- [Runtime values](https://github.com/zz990099/Rigyard/blob/main/docs/configuration/runtime-values.md)
+- [Images](https://github.com/zz990099/Rigyard/blob/main/docs/features/images.md)
+- [Containers](https://github.com/zz990099/Rigyard/blob/main/docs/features/containers.md)
+- [Project builds](https://github.com/zz990099/Rigyard/blob/main/docs/features/builds.md)
+- [Tests](https://github.com/zz990099/Rigyard/blob/main/docs/features/tests.md)
+- [Custom tasks](https://github.com/zz990099/Rigyard/blob/main/docs/features/tasks.md)
+- [Scenarios](https://github.com/zz990099/Rigyard/blob/main/docs/features/scenarios.md)
+- [CLI reference](https://github.com/zz990099/Rigyard/blob/main/docs/reference/cli.md)
+- [Configuration schema reference](https://github.com/zz990099/Rigyard/blob/main/docs/reference/configuration-schema.md)
+- [Exit codes](https://github.com/zz990099/Rigyard/blob/main/docs/reference/exit-codes.md)
+
+Start with the [`minimal`](https://github.com/zz990099/Rigyard/tree/main/examples/minimal) example or browse the complete [`robot-development`](https://github.com/zz990099/Rigyard/tree/main/examples/robot-development) reference project.
+
+## License
+
+[MIT](https://github.com/zz990099/Rigyard/blob/main/LICENSE)
+
+---
+
+Powered by **Codex** — AI-assisted development and documentation.