ofplang-schedule 0.1.0__tar.gz

ofplang_schedule-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+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@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      # `ofplang-validate` is a sibling repo, not on PyPI. The CLI front door
+      # imports it, so install it from git before resolving this project.
+      - run: pip install "ofplang-validate @ git+https://github.com/ofplang/validate.git@main"
+      - run: pip install -e ".[test]"
+      - run: pytest
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      # ruff is a static analyzer: it needs neither the project installed nor the
+      # (PyPI-absent) ofplang-validate dependency resolved, so install ruff alone.
+      - run: pip install "ruff>=0.16"
+      - run: ruff check ofplang tests
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      # mypy resolves `ofplang.validate` (imported by the CLI), so install the
+      # sibling repo from git before this project.
+      - run: pip install "ofplang-validate @ git+https://github.com/ofplang/validate.git@main"
+      - run: pip install -e ".[dev]"
+      - run: mypy

ofplang_schedule-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,96 @@
+name: Publish
+
+# Tag-driven release via PyPI Trusted Publishing (OIDC) — no API tokens.
+#
+# Version comes from the pushed git tag via setuptools-scm (`v0.1.0` -> 0.1.0).
+# Routing:
+#   - a pre-release tag containing `rc` (e.g. v0.1.0rc1) -> TestPyPI (rehearsal)
+#   - any other `v*` tag (e.g. v0.1.0)                    -> PyPI (production)
+#   - manual workflow_dispatch -> choose the target explicitly (run it from a
+#     tagged commit, else setuptools-scm yields a dev+local version PyPI rejects)
+#
+# PyPI-side setup (done once, by the project owner): register a Trusted Publisher
+# for owner=ofplang, repo=schedule, workflow=publish.yml, environment=pypi
+# (and environment=testpypi on TestPyPI). First release: register as "pending".
+#
+# Publish order across the org: validate -> schedule -> run. Do not publish this
+# before ofplang-validate is available on the same index.
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+    inputs:
+      target:
+        description: "Publish target"
+        type: choice
+        options: [testpypi, pypi]
+        default: testpypi
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # setuptools-scm derives the version from tags + history.
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install --upgrade build twine
+      - run: python -m build
+      - run: twine check dist/*
+      # Guard against ambiguous tags: the built version (from setuptools-scm) must
+      # equal the pushed tag — e.g. tag v0.1.0 must build 0.1.0. Catches a commit
+      # carrying two tags (an rc and a release) where git describe can resolve to
+      # the wrong one and publish the wrong artifact.
+      - name: Verify built version matches tag
+        if: startsWith(github.ref, 'refs/tags/')
+        shell: bash
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          built="$(ls dist/*.tar.gz | sed -E 's#.*/[^/]*-([0-9][^-]*)\.tar\.gz#\1#')"
+          echo "tag=$tag built=$built"
+          if [ "$tag" != "$built" ]; then
+            echo "::error::built version $built != tag $tag (ambiguous or misplaced tag?)"
+            exit 1
+          fi
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    needs: build
+    if: >-
+      github.event_name == 'workflow_dispatch' && inputs.target == 'testpypi'
+      || (github.event_name == 'push' && contains(github.ref_name, 'rc'))
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    needs: build
+    if: >-
+      github.event_name == 'workflow_dispatch' && inputs.target == 'pypi'
+      || (github.event_name == 'push' && !contains(github.ref_name, 'rc'))
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

ofplang_schedule-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[cod]
+.pytest_cache/
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+
+# Local working notes, not part of the published project (until explicitly committed).
+CLAUDE.md
+dev-notes/

ofplang_schedule-0.1.0/LICENSE

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

ofplang_schedule-0.1.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: ofplang-schedule
+Version: 0.1.0
+Summary: Object-flow programming language v0 scheduler
+Author-email: Kazunari Kaizu <kwaizu@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/ofplang/schedule
+Project-URL: Repository, https://github.com/ofplang/schedule
+Keywords: ofplang,dataflow,workflow,scheduler,cp-sat,ortools
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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 :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: ortools>=9.10
+Requires-Dist: ofplang-validate
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.16; extra == "dev"
+Requires-Dist: mypy>=1.11; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Dynamic: license-file
+
+# ofplang schedule
+
+[![CI](https://github.com/ofplang/schedule/actions/workflows/ci.yml/badge.svg)](https://github.com/ofplang/schedule/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/ofplang-schedule.svg)](https://pypi.org/project/ofplang-schedule/)
+
+A scheduler for **Object-flow Programming Language v0** — a YAML-based dataflow
+workflow IR with linear Object tracking. The language is defined in the
+[ofplang/spec](https://github.com/ofplang/spec) repository.
+
+The scheduler takes a portable v0 workflow plus an execution environment
+definition and plans when its work runs; it also replans from an execution
+status. The design is documented in [docs/SPECIFICATIONS.md](docs/SPECIFICATIONS.md).
+
+> **Status:** the **schema validators** (environment definition and execution
+> document, spec §9) and the **scheduler** are implemented: it produces a
+> makespan-optimal plan for a single workflow with mode selection, spot/device
+> occupancy, and transport, pins a workflow's boundary material to spots via an
+> `interface` (spec §6.8), and **replans** from an execution document (`--document`)
+> by fixing completed/running activities and re-optimising the rest at or after
+> `now` (device-local resources not yet). A `visualize` command renders a plan as
+> a self-contained SVG/HTML Gantt chart. The model is documented in
+> [docs/FORMULATION.md](docs/FORMULATION.md).
+
+This is a fresh implementation that targets the spec directly. The prototype
+[`ofp-scheduler`](https://github.com/ofplang) (OR-Tools CP-SAT) is a reference
+for ideas but not a dependency.
+
+## Install
+
+```sh
+pip install ofplang-schedule
+```
+
+Requires Python 3.10+. Runtime dependencies are PyYAML, OR-Tools (the CP-SAT
+solver used by the scheduler), and the sibling
+[`ofplang-validate`](https://pypi.org/project/ofplang-validate/) (pulled in
+automatically), which the CLI's front-door check uses. The scheduler *library*
+never imports validate, so embedders that only call `ofplang.schedule` take no
+validation overhead.
+
+For development, install editable with the test extra from a clone:
+
+```sh
+pip install -e ".[test]"
+```
+
+## Command line
+
+```sh
+ofp-schedule validate <file>...                 # validate an environment or a plan/status
+ofp-schedule schedule <workflow> --env <env> [--document doc.yaml] [--running-margin N] [--seed N] [-o plan.yaml] [--format yaml|json]
+ofp-schedule visualize <plan> [--view device|workflow|lane] [--theme light|dark|auto] [-o out.svg]
+```
+
+`validate` auto-detects whether the file is an environment definition or an
+execution document (pass `--kind` to force it); diagnostics are reported as
+`file:line:col: <severity> <code>`. `schedule` produces an execution plan (§6)
+that minimises makespan. A `--document` (execution document, §6) supplies the
+`interface` boundary constraint (§6.8, where a workflow's entry inputs / final
+outputs sit) and, when it sets `now`, the prior status to replan from (§7) —
+emitting the full timeline (fixed history + re-optimised future) that round-trips
+as the next status input. By default the solve is non-deterministic
+(a multi-worker search that may return a different equally-optimal schedule each
+run); `--seed N` makes it reproducible by fixing the CP-SAT seed and using a
+single worker. `visualize` renders a plan as a self-contained Gantt
+chart — SVG by default (fixed colours, transparent background, PowerPoint-safe)
+or HTML. Exit codes: `0` success, `1` validation errors or no feasible schedule,
+`2` usage/input error.
+
+This tool is also intended to be exposed as the `schedule` subcommand of the
+umbrella `ofp` CLI (a separate repository in the `ofplang` organization).
+
+The package lives under the `ofplang` PEP 420 namespace (`ofplang.schedule`),
+shared across the organization's tools.
+
+## Tests
+
+```sh
+pytest
+```

ofplang_schedule-0.1.0/README.md

@@ -0,0 +1,80 @@
+# ofplang schedule
+
+[![CI](https://github.com/ofplang/schedule/actions/workflows/ci.yml/badge.svg)](https://github.com/ofplang/schedule/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/ofplang-schedule.svg)](https://pypi.org/project/ofplang-schedule/)
+
+A scheduler for **Object-flow Programming Language v0** — a YAML-based dataflow
+workflow IR with linear Object tracking. The language is defined in the
+[ofplang/spec](https://github.com/ofplang/spec) repository.
+
+The scheduler takes a portable v0 workflow plus an execution environment
+definition and plans when its work runs; it also replans from an execution
+status. The design is documented in [docs/SPECIFICATIONS.md](docs/SPECIFICATIONS.md).
+
+> **Status:** the **schema validators** (environment definition and execution
+> document, spec §9) and the **scheduler** are implemented: it produces a
+> makespan-optimal plan for a single workflow with mode selection, spot/device
+> occupancy, and transport, pins a workflow's boundary material to spots via an
+> `interface` (spec §6.8), and **replans** from an execution document (`--document`)
+> by fixing completed/running activities and re-optimising the rest at or after
+> `now` (device-local resources not yet). A `visualize` command renders a plan as
+> a self-contained SVG/HTML Gantt chart. The model is documented in
+> [docs/FORMULATION.md](docs/FORMULATION.md).
+
+This is a fresh implementation that targets the spec directly. The prototype
+[`ofp-scheduler`](https://github.com/ofplang) (OR-Tools CP-SAT) is a reference
+for ideas but not a dependency.
+
+## Install
+
+```sh
+pip install ofplang-schedule
+```
+
+Requires Python 3.10+. Runtime dependencies are PyYAML, OR-Tools (the CP-SAT
+solver used by the scheduler), and the sibling
+[`ofplang-validate`](https://pypi.org/project/ofplang-validate/) (pulled in
+automatically), which the CLI's front-door check uses. The scheduler *library*
+never imports validate, so embedders that only call `ofplang.schedule` take no
+validation overhead.
+
+For development, install editable with the test extra from a clone:
+
+```sh
+pip install -e ".[test]"
+```
+
+## Command line
+
+```sh
+ofp-schedule validate <file>...                 # validate an environment or a plan/status
+ofp-schedule schedule <workflow> --env <env> [--document doc.yaml] [--running-margin N] [--seed N] [-o plan.yaml] [--format yaml|json]
+ofp-schedule visualize <plan> [--view device|workflow|lane] [--theme light|dark|auto] [-o out.svg]
+```
+
+`validate` auto-detects whether the file is an environment definition or an
+execution document (pass `--kind` to force it); diagnostics are reported as
+`file:line:col: <severity> <code>`. `schedule` produces an execution plan (§6)
+that minimises makespan. A `--document` (execution document, §6) supplies the
+`interface` boundary constraint (§6.8, where a workflow's entry inputs / final
+outputs sit) and, when it sets `now`, the prior status to replan from (§7) —
+emitting the full timeline (fixed history + re-optimised future) that round-trips
+as the next status input. By default the solve is non-deterministic
+(a multi-worker search that may return a different equally-optimal schedule each
+run); `--seed N` makes it reproducible by fixing the CP-SAT seed and using a
+single worker. `visualize` renders a plan as a self-contained Gantt
+chart — SVG by default (fixed colours, transparent background, PowerPoint-safe)
+or HTML. Exit codes: `0` success, `1` validation errors or no feasible schedule,
+`2` usage/input error.
+
+This tool is also intended to be exposed as the `schedule` subcommand of the
+umbrella `ofp` CLI (a separate repository in the `ofplang` organization).
+
+The package lives under the `ofplang` PEP 420 namespace (`ofplang.schedule`),
+shared across the organization's tools.
+
+## Tests
+
+```sh
+pytest
+```