diff --git a/CHANGELOG.md b/CHANGELOG.md index 44dc7bc..86a8037 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,25 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/ja/1.1.0/), --- +## 0.1.3 +Released: 2026-07-04 + +### Added + +- `GenFlux` / `GenFluxError` を互換 alias として復元し、既存ユーザーの `from genflux import GenFlux` / `GenFluxError` import を維持 +- `Genflux` / `GenfluxError` を推奨名として残しつつ、新旧両方の import をテストで固定 + +### Changed + +- README、API Reference、LLM context、サンプル、生成スクリプトの GENFLUX ブランド表記と SDK ドキュメントを整理 +- `MetricResult` の docstring と評価メトリクス仕様ドキュメントを追加 + +### Breaking changes + +- なし。旧名 `GenFlux` / `GenFluxError` は互換 alias として維持 + +--- + ## 0.1.2 Released: 2026-03-02 @@ -66,7 +85,8 @@ Released: 2026-03-02 - なし（初回リリースのため） -[Unreleased]: https://github.com/elith-co-jp/genflux-python-sdk/compare/v0.1.2...HEAD +[Unreleased]: https://github.com/elith-co-jp/genflux-python-sdk/compare/v0.1.3...HEAD +[0.1.3]: https://github.com/elith-co-jp/genflux-python-sdk/compare/v0.1.2...v0.1.3 [0.1.2]: https://github.com/elith-co-jp/genflux-python-sdk/compare/v0.1.1...v0.1.2 [0.1.1]: https://github.com/elith-co-jp/genflux-python-sdk/compare/v0.1.0...v0.1.1 [0.1.0]: https://github.com/elith-co-jp/genflux-python-sdk/releases/tag/v0.1.0 diff --git a/README.md b/README.md index 5b7ff09..4022210 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ GENFLUX Platform 公式 Python SDK。RAG システムの回答品質スコアリング、セキュリティテスト、ポリシーチェックを Python から実行できます。

-[![Version](https://img.shields.io/badge/version-0.1.2-blue.svg)](https://github.com/elith-co-jp/genflux-python-sdk/releases/tag/v0.1.2) +[![Version](https://img.shields.io/badge/version-0.1.3-blue.svg)](https://github.com/elith-co-jp/genflux-python-sdk/releases/tag/v0.1.3) [![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) diff --git a/docs/API_REFERENCE.md b/docs/API_REFERENCE.md index 07d9ead..3b84e6c 100644 --- a/docs/API_REFERENCE.md +++ b/docs/API_REFERENCE.md @@ -1,6 +1,6 @@ - + # GENFLUX Python SDK - API Reference @@ -1306,6 +1306,6 @@ result = client.jobs.wait(job.id, callback=callback) --- -*Auto-generated at 2026-04-10 14:02 UTC by `scripts/generate_api_reference.py`* +*Auto-generated at 2026-07-04 13:16 UTC by `scripts/generate_api_reference.py`* - + diff --git a/docs/DEVELOPER_API_REFERENCE.md b/docs/DEVELOPER_API_REFERENCE.md index 5f8c199..44def3b 100644 --- a/docs/DEVELOPER_API_REFERENCE.md +++ b/docs/DEVELOPER_API_REFERENCE.md @@ -1,6 +1,6 @@ - + # GENFLUX Python SDK - Developer API Reference @@ -1647,6 +1647,6 @@ job.wait()用のプログレスコールバックを作成します。 --- -*Auto-generated at 2026-04-10 14:02 UTC by `scripts/generate_api_reference.py`* +*Auto-generated at 2026-07-04 13:16 UTC by `scripts/generate_api_reference.py`* - + diff --git a/llms-full.txt b/llms-full.txt index 6e942cb..23f3b0b 100644 --- a/llms-full.txt +++ b/llms-full.txt @@ -79,9 +79,9 @@ Priority: `GENFLUX_API_BASE_URL` > `GENFLUX_ENVIRONMENT` > default (`"prod"`). Everything exported from `genflux/__init__.py`: ```python -# Clients: Genflux, ConfigClient, EvaluationClient, JobsClient, ReportsClient +# Clients: Genflux, GenFlux, ConfigClient, EvaluationClient, JobsClient, ReportsClient # Models: Config, ConfigCreate, ConfigUpdate, ConfigListResponse, Job, JobProgress, MetricResult, Report, ReportSummary, ReportDetails, EvaluationSummary, RedTeamSummary, PolicySummary, CategoryBreakdown, FailedCase, Violation -# Errors: GenfluxError, APIError, AuthenticationError, NotFoundError, ValidationError, TimeoutError, JobFailedError, RateLimitError, ConfigNotFoundError, ResourceNotFoundError +# Errors: GenfluxError, GenFluxError, APIError, AuthenticationError, NotFoundError, ValidationError, TimeoutError, JobFailedError, RateLimitError, ConfigNotFoundError, ResourceNotFoundError # Utils: ProgressBar, create_progress_callback ``` diff --git a/llms.txt b/llms.txt index b9d77e0..cfa3dad 100644 --- a/llms.txt +++ b/llms.txt @@ -61,7 +61,7 @@ Priority: `GENFLUX_API_BASE_URL` > `GENFLUX_ENVIRONMENT` > default (`"prod"`). ## Tech Stack -- Python >= 3.11, SDK version 0.1.2 +- Python >= 3.11, SDK version 0.1.3 - HTTP client: httpx - Data models: Pydantic v2 (BaseModel) + dataclasses - Build: hatchling, managed with uv diff --git a/pyproject.toml b/pyproject.toml index debb07e..e151bc1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "genflux" -version = "0.1.2" +version = "0.1.3" description = "Python SDK for GENFLUX API - RAG Evaluation Platform" readme = "README.md" license = "MIT" diff --git a/scripts/generate_llms_txt.py b/scripts/generate_llms_txt.py index bf87e63..2e30933 100644 --- a/scripts/generate_llms_txt.py +++ b/scripts/generate_llms_txt.py @@ -653,7 +653,7 @@ def _generate_llms_full_txt(info: SDKInfo) -> str: lines.append("") lines.append("```python") # Group them - clients = [n for n in info.public_api if n.endswith("Client") or n == "Genflux"] + clients = [n for n in info.public_api if n.endswith("Client") or n in ("Genflux", "GenFlux")] _util_names = ("ProgressBar", "create_progress_callback") models = [ n for n in info.public_api @@ -985,4 +985,3 @@ def main() -> int: if __name__ == "__main__": sys.exit(main()) - diff --git a/src/genflux/__init__.py b/src/genflux/__init__.py index 9475ac6..258e7ae 100644 --- a/src/genflux/__init__.py +++ b/src/genflux/__init__.py @@ -16,6 +16,7 @@ APIError, AuthenticationError, ConfigNotFoundError, + GenFluxError, GenfluxError, JobFailedError, NotFoundError, @@ -48,11 +49,14 @@ # Progress from genflux.progress import ProgressBar, create_progress_callback -__version__ = "0.1.2" +GenFlux = Genflux + +__version__ = "0.1.3" __all__ = [ # Main Client "Genflux", + "GenFlux", # Specialized Clients "ConfigClient", "EvaluationClient", @@ -80,6 +84,7 @@ "create_progress_callback", # Exceptions "GenfluxError", + "GenFluxError", "APIError", "AuthenticationError", "NotFoundError", diff --git a/src/genflux/exceptions/__init__.py b/src/genflux/exceptions/__init__.py index 4c3adc8..a8579d8 100644 --- a/src/genflux/exceptions/__init__.py +++ b/src/genflux/exceptions/__init__.py @@ -4,6 +4,7 @@ APIError, AuthenticationError, ConfigNotFoundError, + GenFluxError, GenfluxError, JobFailedError, NotFoundError, @@ -15,6 +16,7 @@ __all__ = [ "GenfluxError", + "GenFluxError", "APIError", "AuthenticationError", "NotFoundError", diff --git a/src/genflux/exceptions/api.py b/src/genflux/exceptions/api.py index f5d97b0..5ccb9eb 100644 --- a/src/genflux/exceptions/api.py +++ b/src/genflux/exceptions/api.py @@ -78,6 +78,9 @@ class GenfluxError(Exception): pass +GenFluxError = GenfluxError + + class APIError(GenfluxError): """APIリクエストが失敗しました。""" @@ -255,4 +258,3 @@ def __init__(self, resource_type: str, resource_id: str): self.resource_type = resource_type self.resource_id = resource_id super().__init__(f"{resource_type} {resource_id} not found") - diff --git a/tests/test_backward_compatibility.py b/tests/test_backward_compatibility.py new file mode 100644 index 0000000..11d93b3 --- /dev/null +++ b/tests/test_backward_compatibility.py @@ -0,0 +1,16 @@ +from genflux import ( + GenFlux, + Genflux, + GenFluxError, + GenfluxError, +) + + +def test_legacy_client_name_aliases_preferred_client_name() -> None: + """Legacy client import remains an alias of the preferred client name.""" + assert GenFlux is Genflux + + +def test_legacy_base_exception_aliases_preferred_base_exception() -> None: + """Legacy base exception import remains an alias of the preferred name.""" + assert GenFluxError is GenfluxError diff --git a/uv.lock b/uv.lock index 3c934d0..609735c 100644 --- a/uv.lock +++ b/uv.lock @@ -314,7 +314,7 @@ wheels = [ [[package]] name = "genflux" -version = "0.1.2" +version = "0.1.3" source = { editable = "." } dependencies = [ { name = "httpx" },