Skip to content

README.ja.md

Latest commit

 

History

History
93 lines (72 loc) · 3.94 KB

README.ja.md

File metadata and controls

93 lines (72 loc) · 3.94 KB
Raw

schedule-writer

🇬🇧 English README

強化スケジュール DSL プログラム（contingency-dsl の表層構文）を手書き することなく組み立てるためのビルダ API、CLI、スタンドアロン HTML ツール。

想定読者は、文法を暗記せずドロップダウンとパラメータ入力から Conc(VI 30s, VI 60s) のようなスケジュールを組み立てたい実務家と研究者。

コンポーネント

  • schedule_writer.builder — 純 Python の流暢な API。関数は DSL 文字列を返す; パース・評価・実行は一切行わない。希望があれば コンシューマは出力を contingency-dsl-py にパイプして検証できる。
  • schedule_writer.cli — 2 つのサブコマンドを持つコマンドライン・ エントリポイント:
    • schedule-writer build <schedule> <args...> — 単発構築 （例: schedule-writer build fr 5 は FR 5 を出力）。
    • schedule-writer interactive — スケジュール・ファミリとパラメータ をプロンプトで聞き、結果の DSL 文字列を出力するガイド付き REPL。
  • schedule_writer.standalone_html — CDN 無し、外部スクリプト無しの 自己完結型 HTML ファイルを生成する。バニラ JS のドロップダウンと 入力でクライアントサイドで DSL 文字列を計算する。Python 環境を持た ないユーザへのツール配布に有用。
  • schedule_writer.block_editor_html — ビジュアルブロック型のドラッグ＆ドロップ エディタを単一の自己完結型 HTML として生成する。左のパレット から原子スケジュール・コンビネータ・アノテーションのブロックを キャンバスへドラッグし、複合ブロックのスロットに別のブロックを入れ子に ドロップできる。DSL 文字列はブロック木からライブでコンパイルされる。 エンジニアではない実務家を対象とする。

インストール（開発）

mise exec -- python -m venv .venv
.venv/bin/python -m pip install -e ".[dev]"

使用方法

ビルダ API

from schedule_writer.builder import ScheduleBuilder

b = ScheduleBuilder()
b.fr(5)                       # "FR 5"
b.vi(30)                      # "VI 30s"
b.concurrent(b.vi(30), b.vi(60))   # "Conc(VI 30s, VI 60s)"
b.chained(b.fr(5), b.fi(30))       # "Chain(FR 5, FI 30s)"
b.with_annotation(b.fr(5), "@reinforcer(food)")
#   "FR 5 @reinforcer(food)"

CLI

schedule-writer --help
schedule-writer build fr 5
schedule-writer build vi 30
schedule-writer build conc "VI 30s" "VI 60s"
schedule-writer interactive

スタンドアロン HTML（フォーム型）

schedule-writer html --output schedule-writer.html
# schedule-writer.html を任意のブラウザで開く。オフラインで動作する。

ブロックエディタ HTML（ビジュアルブロック型ドラッグ＆ドロップ）

schedule-writer blocks --output schedule-writer-blocks.html
# 任意のブラウザで開く。左のパレットからブロックをキャンバスへドラッグし、
# 複合ブロックのスロットに別のブロックを入れ子にドロップする。オフライン動作。

出力文法

生成される文字列は contingency-dsl の operant 文法に従う。 時間領域スケジュールはデフォルトで単位接尾辞 (s, ms, min) を 付加する; 比率領域スケジュールは単純な数値を発する (FR 5, VR 20)。 複合スケジュールは正典コンビネータ名を使う: Conc, Mult, Chain, Tand, Alt。

ステータス

Alpha。ビルダ API は DSL の表層構文を反映するが、結果を形式文法に 対してパース・検証することは自身で行わない。コンシューマは出力を 下流パーサへの入力テキストとして扱うべき。