wonderfish-cp-sdk

Product ServiceからMVP Control Planeを呼び出すPython SDK。型付きclient、Managed Identity認証、Catalog cache、顧客・Product Service間Token検証を提供する。公開仕様はSDK仕様書、HTTP契約はcontractsを参照する。

取得

Python 3.12以上で、正式公開後にPublic PyPIのversionを固定して導入する。

pip install wonderfish-cp-sdk==12.0.0

次期12.0.0は、クラウド環境をdev・prodに限定し、管理下ResourceとバージョンなしAPIパスに対応したControl Plane（CP main cc6d0e2d以降）を前提とする。取り込んだ契約がCPの配置より先行しているため、接続先のCPへ反映してから導入する。

公開前のlocal検証ではこのcommitからwheelをビルドし、そのwheelを検証環境へ導入する。正式配置では公開済みwheelを使う。

ローカル検証

python -m pip install --require-hashes -r requirements-dev.lock
python -m pip install --require-hashes -r deployment/sample/requirements.lock
python -m ruff check src tests deployment .github/scripts
python -m compileall -q src tests deployment .github/scripts
python -m pytest
python -m pip_audit -r requirements-dev.lock
python -m pip_audit -r deployment/sample/requirements.lock
node --check deployment/sample/assets/ui.mjs
node --test tests/test_sample_*.mjs
python deployment/sample/download_msal.py
python -c "import pathlib, shutil; [shutil.rmtree(p, ignore_errors=True) for p in [pathlib.Path('build'), pathlib.Path('dist'), *pathlib.Path('src').glob('*.egg-info')]]"
python -m build --wheel --no-isolation
python -m twine check --strict dist/*.whl
python .github/scripts/validate_wheel.py dist 12.0.0
python -m pip install --force-reinstall --no-deps dist/*.whl
python deployment/sample/smoke.py

ブラウザー処理の検証にはNode.js 22.23.2を使う。MSAL取得はビルド時の固定hash検査であり、pytestとNodeテストにはネットワークを使わない。

pytestとNodeテスト、smokeはネットワーク不要の開発検証。依存導入・監査・MSAL取得にはネットワークを使う。実CPとのHTTP・画面の結合試験はサンプル開発手順と試験項目書に従い、localの実CPとDevの実Managed Identityの結果を別に記録する。sample Docker imageのlock同期はDockerfileが指定する固定Python imageでpip-compileして確認する。

PyPIへの公開

pyproject.toml の version を未公開の正式Semantic Versionに更新し、ローカル検証後に main → release のPRを作成する。必須チェック sdk・release-ready の成功後にマージすると、wheelのビルド・検証、PyPIへの公開、v<version> tagの付与を順に実行する。公開workflowはreleaseへのpush時に、対象commitが同一リポジトリのマージ済みmain→release PRのmerge commitであることをGitHub APIで検証する。mainへのpush・PRでは公開しない。

認証はPyPIのTrusted Publisherを使用する。登録先はowner HappyHackInc、repository hh-wonderfish-ai-sdk、workflow publish-pypi.yml、Environment pypi とし、GitHub側の pypi Environmentは release ブランチだけを許可する。公開済みversionとtagは変更せず、修正には新しいversionを使う。

構成

SDKはApache License 2.0で提供する。脆弱性・秘密情報は公開Issueへ記載せずsupport@happyhack.co.jpへ連絡する。