ttflow 0.5.8__tar.gz

ttflow-0.5.8/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - run: uv sync --extra web
+      - run: make lint
+
+  test:
+    name: test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync --extra web
+      - run: uv run pytest --cov --cov-report=xml
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml

ttflow-0.5.8/.github/workflows/docs.yml

@@ -0,0 +1,27 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dependencies
+        run: uv sync --group docs
+
+      - name: Build and deploy docs
+        run: uv run --group docs mkdocs gh-deploy --force

ttflow-0.5.8/.github/workflows/python-package.yml

@@ -0,0 +1,62 @@
+name: build package
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync --extra web
+      - run: uv run pytest
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: softprops/action-gh-release@v3
+        with:
+          files: dist/*
+
+  pypi-publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Trusted Publisher認証に必要
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

ttflow-0.5.8/.gitignore

@@ -0,0 +1,147 @@
+### https://raw.github.com/github/gitignore/218a941be92679ce67d0484547e3e142b2f5f6f0/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+
+
+states/*
+
+# Claude Code
+.claude/settings.local.json

ttflow-0.5.8/CLAUDE.md

@@ -0,0 +1,72 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## プロジェクト概要
+
+ttflowは軽量なPythonワークフローエンジン。イベント駆動でワークフローを実行し、pause/resumeによる長時間ワークフローをサポートする。状態はStateRepositoryに永続化され、ワークフロー関数自体はステートレスかつ再実行可能。
+
+## 開発コマンド
+
+```bash
+make test          # pytest実行
+make fmt           # ruffでフォーマット＋自動修正
+make lint          # ruffでリント＋フォーマットチェック
+
+# 単一テスト実行
+uv run pytest tests/test_pause.py -v
+uv run pytest tests/test_pause.py::test_pause_once -v
+
+# ネットワークテスト（通常スキップ）を含める場合
+uv run pytest -m network
+```
+
+## アーキテクチャ
+
+### 実行モデル
+
+`client.run(trigger_name)` が呼ばれると:
+1. StateRepositoryのロックを取得
+2. バッファリングモード開始（状態読み書きをキャッシュ）
+3. イベントキューにトリガーイベントを追加し、キューが空になるまで処理
+4. バッファをflushしてロック解放
+
+### コア構造
+
+- **`ttflow/ttflow.py`** — `Client`クラスと`setup()`。エントリポイント
+- **`ttflow/core/workflow.py`** — `@workflow`/`@sideeffect`デコレータ、`exec_workflow()`
+- **`ttflow/core/pause.py`** — `PauseException`によるpause/resume機構
+- **`ttflow/core/state.py`** — `get_state`/`set_state`（再実行時はキャッシュから返す）
+- **`ttflow/core/event.py`** — イベントキューイングと永続化
+- **`ttflow/core/run_context.py`** — ワークフロー内で使うAPI（`c.get_state`, `c.log`, `c.pause_once`等）
+- **`ttflow/state_repository/`** — 永続化バックエンド（local file, S3, DynamoDB, on-memory）
+- **`ttflow/state_repository/buffer_cache_proxy.py`** — 読み取りキャッシュ＋書き込みバッファのプロキシ層
+
+### 冪等性の仕組み
+
+ワークフローはpause/resume時に最初から再実行される。安全に再実行するため:
+- `set_state()` — 初回のみ実行、再実行時はno-op
+- `get_state()` — 初回でキャッシュ、再実行時はキャッシュ値を返す
+- `@sideeffect()` — 副作用関数を`run_id`ごとに1回だけ実行
+
+### トリガー種別
+
+- `event_trigger(name)` — 名前付きイベントで発火
+- `every_trigger()` — 毎回の`client.run()`で発火
+- `state_trigger(state_name)` — 状態変更時に発火
+
+## コーディング規約
+
+- コメント・ドキュメントは日本語
+- コミットメッセージは日本語
+- パッケージ管理: uv
+- フォーマッタ/リンタ: ruff
+- テストには`@pytest.mark.network`マーカーでネットワーク依存テストを分離
+- **コード変更後は必ず `make fmt` と `make lint` を実行し、エラーがない状態にすること**（CIで同じチェックが走る）
+
+## ドキュメント運用
+
+- **リファクタリング計画**: `docs/refactor_and_modernize.md` に全体計画を記載
+- **開発メモ**: `docs/開発メモ/` に議事録を連番で蓄積する（例: `01_開発再開.md`, `02_xxx.md`）
+  - 議論と方針決定があるたびに新しいファイルを作成する
+  - 決定事項・経緯・背景を記録する

ttflow-0.5.8/Makefile

@@ -0,0 +1,35 @@
+# Run all checks (autofix + lint + test) — same as CI
+.PHONY: all
+all: fmt lint test
+
+# Run tests with verbose output
+.PHONY: test
+test:
+	uv run pytest -vv
+
+# Run tests with coverage report
+.PHONY: coverage
+coverage:
+	uv run pytest --cov --cov-report=term-missing --cov-report=xml
+
+# Auto-format code and apply safe lint fixes
+.PHONY: fmt
+fmt:
+	uv run ruff format .
+	uv run ruff check --fix .
+
+# Check for lint errors and formatting issues (no modifications)
+.PHONY: lint
+lint:
+	uv run ruff check .
+	uv run ruff format --check .
+
+# Serve docs locally with live reload
+.PHONY: docs
+docs:
+	uv run --group docs mkdocs serve
+
+# Build docs for deployment
+.PHONY: docs-build
+docs-build:
+	uv run --group docs mkdocs build --strict

ttflow-0.5.8/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: ttflow
+Version: 0.5.8
+Summary: simple workflow engine
+Author-email: moajo <moajodev@gmail.com>
+Requires-Python: >=3.11
+Requires-Dist: boto3-stubs[essential]>=1.26.42
+Requires-Dist: boto3>=1.26.42
+Requires-Dist: dacite>=1.7.0
+Requires-Dist: fire>=0.5.0
+Provides-Extra: web
+Requires-Dist: fastapi>=0.100.0; extra == 'web'
+Requires-Dist: uvicorn[standard]>=0.20.0; extra == 'web'

ttflow-0.5.8/README.md

@@ -0,0 +1,241 @@
+# ttflow
+
+[![codecov](https://codecov.io/gh/moajo/ttflow/graph/badge.svg)](https://codecov.io/gh/moajo/ttflow)
+
+軽量なPythonワークフローエンジンです。
+
+ペライチのPythonスクリプトがそのままワークフローエンジンとして動きます。
+サーバープロセスは不要なので、待機コストが0になります。
+
+## 特徴
+
+- **サーバー不要** — 常駐プロセスなし。スクリプトを実行するだけ
+- **中断と再開** — 数日〜数週間にわたるワークフローを、途中で中断して後から再開できる
+- **冪等な再実行** — 再開時は最初から再実行されるが、副作用は1回しか実行されない
+- **イベント駆動** — ワークフロー間をイベントで疎結合に連携
+- **永続化バックエンドを選択可能** — ローカルファイル、S3、DynamoDB、オンメモリ
+
+## クイックスタート
+
+### インストール
+
+```bash
+pip install ttflow
+```
+
+### 最小限のワークフロー
+
+```python
+from ttflow import RunContext, setup
+from ttflow.powerup.run_by_cli import run_by_cli
+
+ttflow = setup(state_repository="local:state.json")
+
+@ttflow.workflow()
+def hello(c: RunContext, args: dict):
+    c.log("Hello, ttflow!")
+
+run_by_cli(ttflow)
+```
+
+```bash
+python hello.py run hello
+```
+
+```
+Hello, ttflow!
+
+---------RUN SUMMARY---------
+1件のワークフローが実行されました
+	1件目
+	  ワークフロー名: hello
+	  run_id: ...
+	  状態: succeeded
+	  ログ:
+	    - Hello, ttflow!
+```
+
+## コアコンセプト
+
+### ワークフローとトリガー
+
+`@workflow()` でワークフローを定義し、`client.run(トリガー名)` で実行します。
+
+```python
+@ttflow.workflow()
+def 処理1(c: RunContext, args: dict):
+    c.log("処理1を実行します")
+    c.event("event1", 42)  # イベントを発火
+
+@ttflow.workflow(trigger=event_trigger("event1"))
+def 処理2(c: RunContext, args: int):
+    c.log(f"処理2も実行します: {args}")
+```
+
+`処理1` を実行すると `event1` が発火し、次回の `run()` で `処理2` が自動的にトリガーされます。
+
+トリガーを省略すると、関数名がそのままトリガー名になります（`client.run("処理1")` で実行可能）。
+
+### 中断と再開
+
+`c.pause_once()` でワークフローを中断し、次回の `run()` で続きから再開できます。
+
+```python
+@ttflow.workflow()
+def loop(c: RunContext, args: dict):
+    count = 0
+    while True:
+        c.log(f"loop: {count}週目開始")
+        c.pause_once()  # ここで中断。次回のrun()で再開
+        c.log(f"loop: {count}週目おわり")
+        count += 1
+        if count > 10:
+            break
+```
+
+`c.wait_event(event_name)` を使えば、特定のイベントが発行されるまで中断することもできます。承認フローなどに便利です。
+
+```python
+@ttflow.sideeffect()
+def 承認待ち(c: RunContext):
+    c.wait_event(f"承認:{c.get_context_data().run_id}")
+```
+
+### 冪等な再実行の仕組み
+
+中断から再開するとき、ワークフローは**関数の最初から再実行**されます。メモリ上の状態を保存しているわけではありません。
+
+このままでは副作用が重複して実行されてしまいますが、ttflowは以下の仕組みで冪等性を保証します。
+
+#### `@sideeffect()` — 副作用を1回だけ実行
+
+```python
+@ttflow.sideeffect()
+def send_notification(c: RunContext, message: str):
+    # 外部APIへの通知など。再実行時はスキップされる
+    requests.post("https://...", json={"message": message})
+```
+
+`@sideeffect()` で修飾された関数は、同じ `run_id` で2回目以降の実行時には自動的にスキップされます。
+
+#### `get_state()` / `set_state()` — 再実行に安全な状態管理
+
+```python
+@ttflow.workflow()
+def wf(c: RunContext, args: dict):
+    c.set_state("count", 1)        # 初回のみ書き込み。再実行時はno-op
+    value = c.get_state("count")   # 初回の値がキャッシュされ、再実行時も同じ値を返す
+```
+
+- `set_state()` — 初回のみ実行され、再実行時には何もしない
+- `get_state()` — 初回アクセス時の値をキャッシュし、再実行時も同じ値を返す
+
+これらの仕組みにより、ワークフローは何度再実行されても、あたかも中断地点から再開したかのように振る舞います。
+
+## ユースケース例
+
+### 値段監視
+
+商品の値段を定期的にチェックし、希望価格以下になったら通知するワークフローです。
+
+```python
+@ttflow.workflow()
+def 買いたいもの追加(c: RunContext, args: dict):
+    item_name = args["item_name"]
+    price = args["price"]
+
+    count = 1
+    while True:
+        current_price = 値段を取得(c, item_name)
+        if current_price <= price:
+            c.log(f"{count}回目: {item_name}は{current_price}円!")
+            return
+        c.log(f"{count}回目: {item_name}は{current_price}で買えませんでした")
+        count += 1
+        c.pause_once()  # 次回のrun()まで待機
+
+@ttflow.sideeffect()
+def 値段を取得(c: RunContext, item_name: str) -> int:
+    # 実際にはここで外部APIから価格を取得する
+    return fetch_price_from_api(item_name)
+```
+
+```bash
+python watch_price.py run 買いたいもの追加 '{"item_name":"レモン","price":150}'
+python watch_price.py run  # 定期実行（cronなどで）
+```
+
+`pause_once()` のたびに中断されるので、cronやCloudWatchスケジューラで定期的に `run` を呼べば、値段が下がるまで繰り返しチェックできます。複数の商品を同時に監視することもできます。
+
+### 承認フロー
+
+外部からのイベントを待って再開するパターンです。
+
+```python
+@ttflow.workflow()
+def デプロイ(c: RunContext, args: dict):
+    notification(c, "デプロイを開始します")
+    承認待ち(c)
+    # ↑ 「承認」イベントが来るまで中断される
+    notification(c, "承認されました。デプロイを続行します")
+
+@ttflow.sideeffect()
+def 承認待ち(c: RunContext):
+    c.wait_event(f"承認:{c.get_context_data().run_id}")
+
+@ttflow.sideeffect()
+def notification(c: RunContext, message: str):
+    c.log(message)
+```
+
+```bash
+python deploy.py run デプロイ            # 中断される
+python deploy.py run 承認:<run_id>       # 承認イベントを発行 → 再開
+```
+
+## StateRepository（永続化バックエンド）
+
+`setup()` の `state_repository` 引数でバックエンドを選択します。
+
+| 指定                      | 用途                                 |
+| ------------------------- | ------------------------------------ |
+| `"local:state.json"`      | ローカルファイル。開発・個人利用向け |
+| `"s3:bucket-name/prefix"` | S3。Lambda等のサーバーレス環境向け   |
+| `"dynamodb:table-name"`   | DynamoDB                             |
+| `"onmemory"`              | オンメモリ。テスト向け               |
+
+```python
+ttflow = setup(state_repository="s3:my-bucket/workflows")
+```
+
+## 運用方法
+
+ワークフローは実行してすぐ終了するただのスクリプトなので、様々な運用方法が考えられます。
+
+### ローカル実行
+
+```bash
+python my_workflow.py run トリガー名
+python my_workflow.py run  # 中断中のワークフローを再開
+```
+
+`run_by_cli()` を使うと、[python-fire](https://github.com/google/python-fire) ベースのCLIが利用できます。
+
+### AWS Lambda
+
+Lambda上で動かすのが最も簡単な運用方法です。
+
+```python
+from ttflow import setup
+from ttflow.powerup.run_by_lambda import run_by_lambda
+
+ttflow = setup(state_repository="s3:my-bucket/state")
+
+# ワークフロー定義...
+
+handler = run_by_lambda(ttflow)
+```
+
+- Lambda関数URLやAPI Gatewayからトリガー名を指定して実行
+- CloudWatchスケジューラで定期的に `run()` を呼んで中断中のワークフローを再開
+- 永続化バックエンドにはS3やDynamoDBを使用

ttflow-0.5.8/docs/api/client.md

@@ -0,0 +1,5 @@
+# Client
+
+ワークフローエンジンのメインクラスです。
+
+::: ttflow.ttflow.Client

ttflow-0.5.8/docs/api/errors.md

@@ -0,0 +1,5 @@
+# エラー
+
+ttflowが定義する例外クラスです。
+
+::: ttflow.errors

ttflow-0.5.8/docs/api/pause.md

@@ -0,0 +1,5 @@
+# Pause/Resume
+
+ワークフローの中断・再開機構です。
+
+::: ttflow.core.pause

ttflow-0.5.8/docs/api/powerup.md

@@ -0,0 +1,17 @@
+# Powerup
+
+CLI・Lambda統合のユーティリティです。
+
+## CLI
+
+::: ttflow.powerup.run_by_cli
+    options:
+      members:
+        - run_by_cli
+
+## Lambda
+
+::: ttflow.powerup.run_by_lambda
+    options:
+      members:
+        - run_by_lambda

ttflow-0.5.8/docs/api/run_context.md

@@ -0,0 +1,5 @@
+# RunContext
+
+ワークフロー関数内で使用するランタイムAPIです。
+
+::: ttflow.core.run_context.RunContext

ttflow-0.5.8/docs/api/state.md

@@ -0,0 +1,10 @@
+# 状態管理
+
+ワークフローの状態を管理するAPIです。
+
+::: ttflow.core.state
+    options:
+      members:
+        - set_state
+        - get_state
+        - add_list_state