fastship-py 0.4.0__tar.gz

fastship_py-0.4.0/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: Python CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions: {}
+
+jobs:
+  validation:
+    name: 検査
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: uv のセットアップ
+        # setup-uv は major/minor タグを publish していないため commit hash でピンする
+        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          python-version: "3.14"
+          enable-cache: true
+
+      - name: 依存の同期
+        # --locked で uv.lock と pyproject.toml のズレも検出する。
+        # --all-extras は Taskfile の init と同じ経路 (mypy が sqlalchemy アダプタも検査する)。
+        run: uv sync --locked --all-extras
+
+      - name: フォーマット検査
+        # 整形は ruff format が唯一の基準。差分があれば `task style:fix` で解消する。
+        run: uv run ruff format --check .
+
+      - name: Ruff リント
+        run: uv run ruff check .
+
+      - name: 型チェック
+        run: uv run mypy
+
+      - name: テスト
+        run: uv run pytest
+
+      - name: Import Linter
+        run: uv run lint-imports --no-logo

fastship_py-0.4.0/.github/workflows/claude.yml

@@ -0,0 +1,56 @@
+name: "🧠 Claude"
+
+# 組織共通の Claude ワークフロー (theindiehacker/devops) を呼び出す caller
+on:
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+  pull_request_review:
+    types: [submitted]
+  issues:
+    types: [opened]
+
+# write は呼び出し先の job に渡す分だけを job 側で与える
+permissions: {}
+
+jobs:
+  code-review:
+    if: github.event_name == 'issue_comment' && startsWith(github.event.comment.body, '/code-review')
+    permissions:
+      contents: read
+      actions: read
+      pull-requests: write
+      issues: write
+      id-token: write
+    uses: theindiehacker/devops/.github/workflows/claude-code-review.yml@a6db12cef36ce69e0d76ce26c380c2255d4764ea  # v1.4.1
+    secrets:
+      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
+      ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+
+  security-review:
+    # 実際の pwn request 対策 (ロール判定など) は呼び出し先 claude-security-review.yml の job if で行う。
+    # ここは code-review job と同様、呼び出し先を起動するかどうかの粗いフィルタ
+    if: github.event_name == 'issue_comment' && startsWith(github.event.comment.body, '/security-review')
+    permissions:
+      contents: read
+      actions: read
+      pull-requests: write
+      issues: write
+      id-token: write
+    uses: theindiehacker/devops/.github/workflows/claude-security-review.yml@a6db12cef36ce69e0d76ce26c380c2255d4764ea  # v1.4.1
+    secrets:
+      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
+      ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+
+  claude:
+    permissions:
+      contents: write
+      actions: read
+      pull-requests: write
+      issues: write
+      id-token: write
+    uses: theindiehacker/devops/.github/workflows/claude.yml@a6db12cef36ce69e0d76ce26c380c2255d4764ea  # v1.4.1
+    secrets:
+      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
+      ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}

fastship_py-0.4.0/.github/workflows/publish.yml

@@ -0,0 +1,75 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+# 既定は無権限。必要な job にだけ最小権限を与える。
+permissions: {}
+
+concurrency:
+  group: publish-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: 配布物のビルド
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: uv のセットアップ
+        # setup-uv は major/minor タグを publish していないため commit hash でピンする
+        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          python-version: "3.14"
+          # リリース成果物のビルドではキャッシュを使わない。
+          # PR 経由で汚染されたキャッシュが配布物に混入する経路を断つ (zizmor: cache-poisoning)。
+          enable-cache: false
+
+      - name: タグと pyproject.toml の version が一致することを検証
+        env:
+          TAG: ${{ github.event.release.tag_name }}
+        run: |
+          VERSION="$(python3 -c 'import tomllib, pathlib; print(tomllib.loads(pathlib.Path("pyproject.toml").read_text())["project"]["version"])')"
+          if [ "${TAG#v}" != "$VERSION" ]; then
+            echo "::error::タグ ${TAG} と pyproject.toml の version ${VERSION} が一致しません"
+            exit 1
+          fi
+
+      - name: sdist と wheel をビルド
+        run: uv build --out-dir dist
+
+      - name: 配布物を artifact として保存
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: PyPI へ公開
+    needs: [ build ]
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fastship-py
+    permissions:
+      # OIDC トークンの発行に必須。workflow 単位ではなく job 単位で付与する (公式の強い推奨)
+      id-token: write
+    steps:
+      - name: 配布物を取得
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: PyPI へアップロード
+        # Trusted Publishing (OIDC) のため認証情報の指定は一切不要。
+        # v1.11.0 以降、Trusted Publishing 時は PEP 740 attestation が自動生成・添付される。
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

fastship_py-0.4.0/.gitignore

@@ -0,0 +1,133 @@
+# 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/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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/
+
+# JetBrains IDE (IntelliJ IDEA / PyCharm)
+# 各開発者のローカル設定なので git 管理しない
+.idea/

fastship_py-0.4.0/CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Development
+
+## Set up
+```bash
+task init          # 依存インストール
+task test          # テスト
+task style:check   # ruff format / ruff / mypy / import-linter (自分自身への契約検査)
+task style:fix     # 整形 + lint の自動修正
+```
+
+## Debug
+
+ローカルの変更を、実際のリポジトリに撃って確かめる手順。
+
+```bash
+cd path/to/対象プロジェクト
+uv add --dev --editable path/to/fastship-py   # 一度だけ
+```
+
+## Release
+
+PyPI への公開は GitHub Release をトリガーに、[Trusted Publishing (OIDC)](https://docs.pypi.org/trusted-publishers/) で自動実行される。
+API トークンはリポジトリに置かない。
+
+```bash
+# 1. pyproject.toml の version を上げて main へマージする
+# 2. その version と同じタグで Release を作る (v プレフィックス付き)
+gh release create v0.1.0 --generate-notes
+```
+
+タグと `pyproject.toml` の version が食い違うとワークフローは公開前に落ちる。
+`__version__` は `pyproject.toml` から読むため、バージョンを書き換える箇所は `pyproject.toml` の 1 行だけ。
+
+## CI
+
+PR には以下のチェックが走る。
+
+| ワークフロー | 検知するもの |
+|:---|:---|
+| `ci.yml` | 整形 (ruff format) / lint (ruff) / 型 (mypy) / テスト / アーキテクチャ規約 (import-linter) |
+| `claude.yml` | 検知ではなく呼び出し用。PR に `/code-review`・`/security-review` とコメント、または `@claude` にメンションで Claude を起動する |
+| org の必須ワークフロー | シークレット混入 (Gitleaks) / SAST (Semgrep) / 依存パッケージの脆弱性・IaC の設定ミス (Trivy) / GitHub Actions 定義 (zizmor / ghalint / actionlint) など |
+
+org の必須ワークフローは [theindiehacker/devops](https://github.com/theindiehacker/devops) の定義を org ルールセットで全リポジトリに適用しているため、本リポジトリには置かない。
+
+### `ci.yml` を必須にする (リポジトリ管理者向け)
+
+ワークフローを置いただけではマージはブロックされない。
+Settings → Rules → Rulesets → New branch ruleset で、
+**Target branches** を `Include default branch`、
+**Require status checks to pass** に `検査` を登録する。
+
+> チェック名は job 名がそのまま出たもの。
+> job 名を変えると必須チェックの名前も変わり、PR が永久に pending になるため変更しない。
+
+### 検知の抑制
+
+誤検知の抑制は、org ルールセット「セキュリティ設定変更の承認必須化」の対象である
+設定ファイル (`.gitleaksignore` / `.trivyignore` / `.semgrepignore` / `.github/zizmor.yml`) に限定する。
+各ツールのインライン抑制コメント (gitleaks の allow / Semgrep の nosem /
+Trivy と zizmor の ignore) は承認ゲートを迂回するため、
+各ワークフローで明示的に無効化、または存在自体を禁止している。
+
+> ここでトークンを原文のまま書いていないのは、Trivy ワークフローの禁止チェックが
+> リポジトリ全体を grep するため、この文書自身が検知されてしまうため。
+
+これらの設定ファイルは**検出が実際に出て、誤検知だと判断できた時にだけ**作る。
+先回りして空ファイルを置かないこと。特に `.semgrepignore` は、存在するだけで
+Semgrep の組み込み既定除外リストを置き換えてしまう。

fastship_py-0.4.0/LICENSE

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

fastship_py-0.4.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.5
+Name: fastship-py
+Version: 0.4.0
+Summary: モジュラモノリス + DDD のカーネル。集約・ドメインイベント・UnitOfWork・トランザクショナル outbox/inbox を業務語彙ゼロで提供する
+Project-URL: Homepage, https://github.com/theindiehacker/fastship-py
+Project-URL: Repository, https://github.com/theindiehacker/fastship-py
+Author-email: taiyo tamura <gtaiyou24@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ddd,hexagonal-architecture,modular-monolith,outbox,unit-of-work
+Requires-Python: >=3.14
+Requires-Dist: injector<1.0.0,>=0.22.0
+Requires-Dist: pydantic-settings<3.0.0,>=2.14.2
+Requires-Dist: pydantic<3.0.0,>=2.13.0
+Requires-Dist: pytz>=2026.2
+Provides-Extra: linter
+Requires-Dist: import-linter<3.0.0,>=2.14; extra == 'linter'
+Provides-Extra: sqlalchemy
+Requires-Dist: sqlalchemy<3.0.0,>=2.0.51; extra == 'sqlalchemy'
+Description-Content-Type: text/markdown
+
+# 🚀 fastship-py
+
+```bash
+uv add fastship-py
+uv add "fastship-py[sqlalchemy]"   # SQLAlchemy アダプタも使う場合
+```
+
+## 📚 How To
+### 💾 Persistence
+
+<details><summary><b>💾 テーブルクラス ( SQLAlchemy ) の実装</b></summary>
+
+`〇〇.port.adapter.persistence.repository.sqlalchemy.user.driver.users_table_row.py`
+```python
+from sqlalchemy import String
+from sqlalchemy.orm import Mapped, mapped_column
+
+# NOTE: テーブルクラスは `DataBase` を継承して作ること
+from fastship.common.port.adapter.persistence.sqlalchemy import DataBase
+
+
+class UsersTableRow(DataBase):
+    __tablename__ = "users"
+
+    id: Mapped[str] = mapped_column(String(36), primary_key=True)
+    name: Mapped[str] = mapped_column(String(50), index=True)  # index 名は ix_users_name
+```
+
+`〇〇.port.adapter.persistence.repository.sqlalchemy.user.driver.__init__.py`
+```python
+from .users_table_row import UsersTableRow
+# 他のテーブルクラス
+```
+
+テーブルクラスを足したら、そのモジュールの `tables` にドライバーモジュールのパスを足す
+
+```python
+class 〇〇(AppModule):
+    @property
+    @override
+    def tables(self) -> list[str]:
+        return ["〇〇.port.adapter.persistence.repository.sqlalchemy.user.driver"]
+```
+
+</details>
+
+<details><summary><b>🚚 マイグレーション (Alembic)</b></summary>
+
+事前にマイグレーション用のパッケージを生成
+```bash
+uv add alembic
+uv run alembic init migration
+```
+
+`migration/env.py`:
+```python
+# alembic init の生成物から、target_metadata = None をこの 3 行に差し替える
+
+from fastship.migration import load_metadata
+from core import Backend  # 全モジュールを束ねた CompositeModule
+
+target_metadata = load_metadata(Backend())
+```
+
+</details>
+
+<details><summary><b>🔀 リードレプリカへの読み書き振り分け (SQLAlchemy)</b></summary>
+
+接続先はインフラが環境変数で注入する (Secret Manager の値は実行基盤で環境変数として公開する)。アプリ側では設定しない。
+
+| 環境変数 | 内容 |
+|:---|:---|
+| `DATABASE_WRITER_URL` | プライマリ。必須 |
+| `DATABASE_READER_URL` | リードレプリカ (Read Pool のエンドポイント)。未設定ならすべてプライマリへ送る |
+
+```python
+from fastship.common.port.adapter.persistence.sqlalchemy import SQLAlchemyUnitOfWork
+
+unit_of_work = SQLAlchemyUnitOfWork.from_settings(pool_pre_ping=True)
+```
+
+トランザクション (`unit_of_work.session()`) は、読み取りも含めてすべてプライマリで実行する。
+レプリカの遅延した値を元に更新すると、プライマリの新しい値を上書きしてしまう (lost update) ため。
+更新系の生 SQL (`text()`) もここで実行する。
+
+トランザクション外の読み取り (`unit_of_work.query()`) は、以下の規則でリーダーとライターに振り分ける。
+
+| クエリ | 送り先 |
+|:---|:---|
+| 読み取り (`select()` / `session.get()` / `text()`) | リーダー |
+| 書き込み (flush / `insert()` / `update()` / `delete()`) | ライター |
+| `SELECT ... FOR UPDATE` (`with_for_update()`) | ライター |
+| 一度でもライターへ送ったセッションの以降のクエリ | ライター (書き込み直後に古いデータを読まない) |
+| `session.use_writer()` を呼んだ後のクエリ | ライター (レプリカ遅延を許容できない読み取り) |
+
+```python
+with unit_of_work.query() as session:
+    session.use_writer()
+    session.get(...)
+```
+
+認可の判定 (無効化された API キー、停止されたユーザー、取り消された権限など) は、レプリカ遅延の間に
+古い状態で許可しないよう、`session.use_writer()` を呼んでプライマリから読むこと。
+
+Read Pool のノード数を増減しても、エンドポイントは変わらないためアプリ側の変更は要らない。
+`SessionPreparer` (RLS の `SET LOCAL` など) は、振り分け先のコネクションそれぞれに適用される。
+
+</details>
+
+
+### 🛠️ Other
+
+<details><summary><b>📦 DI コンテナ</b></summary>
+
+登録方法:
+```python
+from sqlalchemy import create_engine
+
+from fastship.common.application import UnitOfWork
+from fastship.common.port.adapter.persistence.inmem import InMemUnitOfWork
+from fastship.common.port.adapter.persistence.sqlalchemy import SQLAlchemyUnitOfWork
+from fastship.di import DI, DIContainer
+
+engine = create_engine("postgresql+psycopg://...")
+
+DIContainer.instance().register(
+    DI.of(UnitOfWork, {"InMem": InMemUnitOfWork()}, SQLAlchemyUnitOfWork(engine)),
+)
+```
+
+利用方法:
+```python
+from fastship.di import DI, DIContainer
+
+# `DI_FOR_PY=InMem` なら InMemUnitOfWork のインタンスを取得
+# `DI_FOR_PY=` なら SQLAlchemyUnitOfWork のインタンスを取得
+unit_of_work = DIContainer.instance().resolve(UnitOfWork)
+```
+
+```python
+from injector import inject
+
+
+class 〇〇ApplicationService:
+    @inject
+    def __init__(self, 〇〇_repository: 〇〇Repository) -> None: ...
+```
+
+```python
+from fastship.common.domain.model import DomainRegistry
+
+〇〇_repository = DomainRegistry.resolve(〇〇Repository)
+```
+
+</details>