Skip to content

refactor: ブランド表記統一 — GenFlux → Genflux / GENFLUX#24

Merged
surumenDD merged 13 commits intodevelopfrom
refactor/23-unify-branding-to-GENFLUX
Mar 27, 2026
Merged

refactor: ブランド表記統一 — GenFlux → Genflux / GENFLUX#24
surumenDD merged 13 commits intodevelopfrom
refactor/23-unify-branding-to-GENFLUX

Conversation

@surumenDD
Copy link
Copy Markdown
Collaborator

Summary

  • 商標登録(GENFLUX)に合わせて、SDK 全体のブランド表記を統一
  • GenFlux(PascalCase・2語風)を文脈に応じて Genflux(クラス名)/ GENFLUX(ブランド名)に修正
  • 42ファイル、約280箇所の変更(機能変更なし)

ブランド表記ガイドライン

コンテキスト 表記
ユーザー向けテキスト・ブランド名 GENFLUX 「GENFLUXは〜」、docstring 説明文
Python クラス名 Genflux class Genflux:, from genflux import Genflux
パッケージ名 genflux pip install genflux(変更なし)
環境変数 GENFLUX_ GENFLUX_API_KEY(変更なし)

変更範囲

  1. src/: クラス定義・例外・サブクライアント・モデル・定数・__init__.py
  2. tests/examples/scripts/: テスト・サンプル・自動生成スクリプト
  3. docs/: README, QUICKSTART, WORKFLOW, EXAMPLES, LOCAL_SETUP 等
  4. 設定: pyproject.toml, GitHub Issue テンプレート
  5. 自動生成: API_REFERENCE.md, DEVELOPER_API_REFERENCE.md, llms.txt, llms-full.txt を再生成

Test plan

  • rg -w "GenFlux" src/ が 0 件
  • rg -w "GenFlux" リポジトリ全体が 0 件(GENFLUX は OK)
  • from genflux import Genflux が動作する
  • from genflux import GenfluxError が動作する
  • uv run ruff check src/ パス
  • uv run pyright src/ パス

Closes #23

- class GenFlux → Genflux, GenFluxError → GenfluxError
- APIError, TimeoutError 等の基底クラス参照を更新
- docstring のブランド表記を GENFLUX に統一

Refs #23
- clients/, jobs.py, evaluation.py, progress.py の docstring → GENFLUX
- 型ヒント・コード例の GenFlux → Genflux

Refs #23
- models/ の docstring → GENFLUX
- constants.py のクラス参照コメント → Genflux
- __init__.py の import・__all__ を Genflux/GenfluxError に更新

Refs #23
- import・インスタンス化の GenFlux → Genflux
- ユーザー向け print 文の GenFlux → GENFLUX

Refs #23
- docstring・print 文の GenFlux → GENFLUX
- import・インスタンス化・コード例の GenFlux → Genflux

Refs #23
- import の GenFlux/GenFluxError → Genflux/GenfluxError
- 生成テキストのブランド名 → GENFLUX
- コード例・クラス参照 → Genflux

Refs #23
- README.md, CHANGELOG.md, CONTRIBUTING.md の GenFlux → GENFLUX/Genflux
- pyproject.toml の description・authors を GENFLUX に統一

Refs #23
- 見出し・説明文の GenFlux → GENFLUX
- コード例の GenFlux → Genflux

Refs #23
- docs/API_REFERENCE.md, DEVELOPER_API_REFERENCE.md を再生成
- llms.txt, llms-full.txt を再生成

Refs #23
@surumenDD surumenDD changed the base branch from main to develop March 23, 2026 18:53
@surumenDD
Copy link
Copy Markdown
Collaborator Author

@coderabbitai full review

@surumenDD
Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

- ソースコード: PR側のクラス名 (Genflux/GenfluxError) + develop側の日本語docstring + GENFLUX表記
- ドキュメント/スクリプト: develop側を採用し Genflux → GENFLUX に置換
- 自動生成ファイル: develop側を採用(make docs で再生成予定)
@surumenDD
Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@surumenDD surumenDD merged commit 8b53989 into develop Mar 27, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

refactor: ブランド表記統一 — GenFlux → Genflux / GENFLUX に修正

1 participant