rdetoolkit 1.3.3__tar.gz → 1.3.4__tar.gz

rdetoolkit-1.3.4/.github/workflows/build-index.yml

@@ -0,0 +1,23 @@
+name: Build Code Index
+on:
+  push:
+    paths:
+      - 'src/**'
+      - 'docs/**'
+      - 'tools/build_index.py'
+  workflow_dispatch: {}
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with: { python-version: '3.x' }
+      - run: python3 tools/build_index.py
+      - name: Commit index
+        run: |
+          git config user.name "github-actions"
+          git config user.email "actions@users.noreply.github.com"
+          git add docs/search/rdetoolkit_code_index.jsonl || true
+          git commit -m "update: code index" || echo "no changes"
+          git push || echo "no push"

{rdetoolkit-1.3.3 → rdetoolkit-1.3.4}/.github/workflows/pr-agent.yaml

@@ -18,10 +18,11 @@ jobs:
     steps:
       - name: PR Agent action step
         id: pragent
-        uses: Codium-ai/pr-agent@main
+        uses: qodo-ai/pr-agent@main
         env:
           OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          GITHUB_ACTION.AUTO_REVIEW: true
-          GITHUB_ACTION.AUTO_DESCRIBE: true
-          GITHUB_ACTION.AUTO_IMPROVE: true
+          github_action_config.auto_review: "true"
+          github_action_config.auto_describe: "true"
+          github_action_config.auto_improve: "true"
+          github_action_config.pr_actions: '["opened","reopened","synchronize","ready_for_review","review_requested"]'

rdetoolkit-1.3.4/.pr_agent.toml

@@ -0,0 +1,49 @@
+[config]
+response_language = "en-US"
+model = "gpt-4.1"
+fallback_models = ["gpt-4.1-mini", "o4-mini"]
+patch_extra_lines_before = 5
+patch_extra_lines_after  = 3
+
+[ignore]
+glob = ['dist/**','build/**','*.min.js','package-lock.json','yarn.lock']
+
+[pr_reviewer]
+num_max_findings = 10
+require_security_review = true
+require_tests_review = true
+require_score_review = true
+require_estimate_effort_to_review = true
+require_can_be_split_review = true
+require_todo_scan = true
+# auto add a label
+enable_review_labels_security = true
+enable_review_labels_effort   = true
+
+extra_instructions = """\
+[Review Lenses | label findings as Blocker / Major / Minor]
+- Correctness & spec compliance; backward compatibility of public APIs
+- Maintainability: readability, separation of concerns, function/module sizing, docs
+- Consistency with project conventions and framework idioms
+- Tests: what’s missing (unit/integration/regression) with concrete examples
+- Security: input validation, secrets exposure, authz/authn gaps, known-CVE dependencies
+- Performance: obvious inefficiencies (unnecessary scans, repeated work, sync I/O bottlenecks)
+- Observability: logs/metrics/error handling suitable for production troubleshooting
+- Scope management: if the PR is too large, propose a sensible split
+
+[Output Format]
+1) Summary (2–4 lines)
+2) Strengths
+3) Concerns (Blocker/Major/Minor) — include filename and line numbers
+4) Concrete Suggestions — minimal-change proposals; include small patch snippets when helpful
+5) Test Gaps — list specific cases to add
+
+[Behavior When Uncertain]
+- Explicitly list assumptions, unknowns, and the additional evidence needed (files, settings, repro steps).
+- Propose concrete verification steps (e.g., which files/keywords to grep, which CI logs/configs to check).
+- Do not assert APIs/specs by guess; offer alternatives with conditions for choosing each.
+- Prioritize review of public APIs, security-sensitive code, and wide-impact areas first.
+- Defer style-only issues to the formatter/linter; flag only rule deviations or readability risks.
+- If the PR is oversized or mixes concerns, ask for a smaller follow-up and suggest a split plan.
+- Keep tone concise, specific, and respectful; avoid generic praise; always reference code lines.
+"""

{rdetoolkit-1.3.3 → rdetoolkit-1.3.4}/Cargo.toml

@@ -2,6 +2,7 @@
 name = "rdetoolkit-core"
 version = "0.2.0"
 edition = "2021"
+readme = "README.md"
 
 [lib]
 name = "rdetoolkit_core"

{rdetoolkit-1.3.3 → rdetoolkit-1.3.4}/PKG-INFO

@@ -1,11 +1,10 @@
 Metadata-Version: 2.4
 Name: rdetoolkit
-Version: 1.3.3
+Version: 1.3.4
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11

{rdetoolkit-1.3.3 → rdetoolkit-1.3.4}/docs/README_ja.md

@@ -1,8 +1,8 @@
-![GitHub Release](https://img.shields.io/github/v/release/nims-dpfc/rdetoolkit)
+![GitHub Release](https://img.shields.io/github/v/release/nims-mdpf/rdetoolkit)
 [![python.org](https://img.shields.io/badge/Python-3.9%7C3.10%7C3.11-%233776AB?logo=python)](https://www.python.org/downloads/release/python-3917/)
-[![MIT License](https://img.shields.io/badge/license-MIT-green)](https://github.com/nims-dpfc/rdetoolkit/blob/main/LICENSE)
-[![Issue](https://img.shields.io/badge/issue_tracking-github-orange)](https://github.com/nims-dpfc/rdetoolkit/issues)
-![workflow](https://github.com/nims-dpfc/rdetoolkit/actions/workflows/main.yml/badge.svg)
+[![MIT License](https://img.shields.io/badge/license-MIT-green)](https://github.com/nims-mdpf/rdetoolkit/blob/main/LICENSE)
+[![Issue](https://img.shields.io/badge/issue_tracking-github-orange)](https://github.com/nims-mdpf/rdetoolkit/issues)
+![workflow](https://github.com/nims-mdpf/rdetoolkit/actions/workflows/main.yml/badge.svg)
 ![coverage](docs/img/coverage.svg)
 
 # RDEToolKit
@@ -108,7 +108,7 @@ def dataset(srcpaths, resource_paths):
 
 ```python
 import rdetoolkit
-from modules.modules import datase  #独自で定義した構造化処理関数
+from modules.modules import dataset  #独自で定義した構造化処理関数
 
 #独自で定義した構造化処理関数を引数として渡す
 rdetoolkit.workflows.run(custom_dataset_function=dataset)

rdetoolkit-1.3.4/docs/api/index.en.md

@@ -0,0 +1,150 @@
+# API Reference
+
+## Purpose
+
+This section provides technical specifications for all features of RDEToolKit. It is a comprehensive reference including detailed functionality, parameters, return values, and usage examples for each module.
+
+## API Documentation Structure
+
+RDEToolKit's API documentation is structured using a hybrid approach:
+
+- **Auto-generated parts**: Detailed technical specifications generated from docstrings in source code
+- **Manually created parts**: Practical usage examples and inter-module collaboration methods
+
+## Core Modules
+
+### Workflow Management
+
+- [workflows](../rdetoolkit/workflows.md) - Structured processing execution and workflow management
+- [modeproc](../rdetoolkit/modeproc.md) - Mode processing
+
+### Configuration and File Operations
+
+- [config](../rdetoolkit/config.md) - Configuration file loading and management
+- [fileops](../rdetoolkit/fileops.md) - RDE-related file operations
+
+### Data Processing
+
+- [invoicefile](../rdetoolkit/invoicefile.md) - Invoice file processing
+- [validation](../rdetoolkit/validation.md) - Data validation
+- [rde2util](../rdetoolkit/rde2util.md) - RDE-related utility functions
+
+### Representative Image Operations
+
+- [img2thumb](../rdetoolkit/img2thumb.md) - Image to thumbnail conversion
+
+### Error Handling and Logging
+
+- [rdelogger](../rdetoolkit/rdelogger.md) - Logging functionality
+- [errors](../rdetoolkit/errors.md) - Error handling
+- [exceptions](../rdetoolkit/exceptions.md) - Exception handling
+
+## Data Models
+
+### Configuration Models
+
+- [models.config](../rdetoolkit/models/config.md) - Configuration data structure definitions
+
+### RDE-related Models
+
+- [models.rde2types](../rdetoolkit/models/rde2types.md) - RDE-related type definitions
+- [models.invoice](../rdetoolkit/models/invoice_schema.md) - Invoice data structure
+- [models.metadata](../rdetoolkit/models/metadata.md) - Metadata management
+
+### Processing Result Models
+
+- Processing result management functionality is integrated into each module
+
+## Implementation Modules
+
+### Controllers
+
+- [impl.input_controller](../rdetoolkit/impl/input_controller.md) - Input mode management
+- [impl.compressed_controller](../rdetoolkit/impl/compressed_controller.md) - Compressed file management
+
+### Interfaces
+
+- [interface.filechecker](../rdetoolkit/interface/filechecker.md) - File validation interface
+
+### Command Line
+
+- [CLI Commands](../usage/cli.ja.md) - Command line interface usage
+
+## Usage Patterns
+
+### Basic Usage
+
+```python title="basic_usage.py"
+import rdetoolkit
+from rdetoolkit.models.rde2types import RdeInputDirPaths, RdeOutputResourcePath
+
+def my_dataset_function(srcpaths: RdeInputDirPaths, resource_paths: RdeOutputResourcePath):
+    # Implement custom processing here
+    pass
+
+# Execute structured processing
+result = rdetoolkit.workflows.run(custom_dataset_function=my_dataset_function)
+```
+
+### Configuration File Usage
+
+```python title="config_usage.py"
+from rdetoolkit.config import parse_config_file
+
+# Load configuration file
+config = parse_config_file()
+
+# Reference configuration values
+extended_mode = config.system.extended_mode
+save_raw = config.system.save_raw
+```
+
+### Error Handling
+
+```python title="error_handling.py"
+from rdetoolkit.exceptions import RdeToolkitError
+from rdetoolkit import workflows
+
+try:
+    result = workflows.run(custom_dataset_function=my_function)
+except RdeToolkitError as e:
+    print(f"RDEToolKit error: {e}")
+    print(f"Error code: {e.error_code}")
+```
+
+## API Version Information
+
+| Version | Compatibility | Major Changes |
+|---------|---------------|---------------|
+| 1.0.x | Stable | Initial release |
+| 1.1.x | Backward compatible | New features added |
+| 1.2.x | Backward compatible | Performance improvements |
+
+!!! note "API Stability"
+    Backward compatibility is maintained within major versions. Breaking changes only occur during major version upgrades.
+
+## Developer Information
+
+### Type Hints
+
+RDEToolKit supports complete type hints:
+
+```python title="type_hints.py"
+from typing import Optional
+from rdetoolkit.models.rde2types import RdeInputDirPaths, RdeOutputResourcePath
+
+def process_data(
+    srcpaths: RdeInputDirPaths,
+    resource_paths: RdeOutputResourcePath,
+    options: Optional[dict] = None
+) -> bool:
+    # Type-safe implementation
+    return True
+```
+
+
+## Next Steps
+
+- Specific module details: Refer to the module links above
+- Practical usage examples: [User Guide](../user-guide/index.en.md)
+- Contributing to development: [Developer Guide](../development/index.en.md)

rdetoolkit-1.3.4/docs/api/index.ja.md

@@ -0,0 +1,150 @@
+# API リファレンス
+
+## 目的
+
+このセクションでは、RDEToolKitの全機能に関する技術仕様を提供します。各モジュールの詳細な機能、パラメータ、返り値、使用例を含む包括的なリファレンスです。
+
+## API ドキュメントの構成
+
+RDEToolKitのAPIドキュメントは、ハイブリッド方式で構成されています：
+
+- **自動生成部分**: ソースコード内のdocstringから生成される詳細な技術仕様
+- **手動作成部分**: 実践的な使用例とモジュール間の連携方法
+
+## 主要モジュール
+
+### ワークフロー管理
+
+- [workflows](../rdetoolkit/workflows.md) - 構造化処理の実行とワークフロー管理
+- [modeproc](../rdetoolkit/modeproc.md) - モード処理
+
+### 設定とファイル操作
+
+- [config](../rdetoolkit/config.md) - 設定ファイルの読み込みと管理
+- [fileops](../rdetoolkit/fileops.md) - RDE関連のファイル操作
+
+### データ処理
+
+- [invoicefile](../rdetoolkit/invoicefile.md) - 送り状ファイルの処理
+- [validation](../rdetoolkit/validation.md) - データの検証
+- [rde2util](../rdetoolkit/rde2util.md) - RDE関連のユーティリティ関数
+
+### 代表画像操作
+
+- [img2thumb](../rdetoolkit/img2thumb.md) - 画像をサムネイルに変換
+
+### エラー処理とログ
+
+- [rdelogger](../rdetoolkit/rdelogger.md) - ロギング機能
+- [errors](../rdetoolkit/errors.md) - エラーハンドリング
+- [exceptions](../rdetoolkit/exceptions.md) - 例外処理
+
+## データモデル
+
+### 設定モデル
+
+- [models.config](../rdetoolkit/models/config.md) - 設定データの構造定義
+
+### RDE関連モデル
+
+- [models.rde2types](../rdetoolkit/models/rde2types.md) - RDE関連の型定義
+- [models.invoice](../rdetoolkit/models/invoice_schema.md) - 送り状データの構造
+- [models.metadata](../rdetoolkit/models/metadata.md) - メタデータの管理
+
+### 処理結果モデル
+
+- 処理結果の管理機能は各モジュールに統合されています
+
+## 実装モジュール
+
+### コントローラー
+
+- [impl.input_controller](../rdetoolkit/impl/input_controller.md) - 入力モードの管理
+- [impl.compressed_controller](../rdetoolkit/impl/compressed_controller.md) - 圧縮ファイルの管理
+
+### インターフェース
+
+- [interface.filechecker](../rdetoolkit/interface/filechecker.md) - ファイル検証インターフェース
+
+### コマンドライン
+
+- [CLIコマンド](../usage/cli.ja.md) - コマンドライン機能の使用方法
+
+## 使用パターン
+
+### 基本的な使用方法
+
+```python title="basic_usage.py"
+import rdetoolkit
+from rdetoolkit.models.rde2types import RdeInputDirPaths, RdeOutputResourcePath
+
+def my_dataset_function(srcpaths: RdeInputDirPaths, resource_paths: RdeOutputResourcePath):
+    # カスタム処理をここに実装
+    pass
+
+# 構造化処理の実行
+result = rdetoolkit.workflows.run(custom_dataset_function=my_dataset_function)
+```
+
+### 設定ファイルの使用
+
+```python title="config_usage.py"
+from rdetoolkit.config import parse_config_file
+
+# 設定ファイルの読み込み
+config = parse_config_file()
+
+# 設定値の参照
+extended_mode = config.system.extended_mode
+save_raw = config.system.save_raw
+```
+
+### エラーハンドリング
+
+```python title="error_handling.py"
+from rdetoolkit.exceptions import RdeToolkitError
+from rdetoolkit import workflows
+
+try:
+    result = workflows.run(custom_dataset_function=my_function)
+except RdeToolkitError as e:
+    print(f"RDEToolKit エラー: {e}")
+    print(f"エラーコード: {e.error_code}")
+```
+
+## API バージョン情報
+
+| バージョン | 互換性 | 主な変更点 |
+|------------|--------|------------|
+| 1.0.x | 安定版 | 初期リリース |
+| 1.1.x | 後方互換 | 新機能追加 |
+| 1.2.x | 後方互換 | パフォーマンス改善 |
+
+!!! note "API の安定性"
+    メジャーバージョン内では後方互換性を維持します。破壊的変更はメジャーバージョンアップ時にのみ行われます。
+
+## 開発者向け情報
+
+### 型ヒント
+
+RDEToolKitは完全な型ヒントをサポートしています：
+
+```python title="type_hints.py"
+from typing import Optional
+from rdetoolkit.models.rde2types import RdeInputDirPaths, RdeOutputResourcePath
+
+def process_data(
+    srcpaths: RdeInputDirPaths,
+    resource_paths: RdeOutputResourcePath,
+    options: Optional[dict] = None
+) -> bool:
+    # 型安全な実装
+    return True
+```
+
+
+## 次のステップ
+
+- 特定のモジュールの詳細: 上記のモジュールリンクを参照
+- 実践的な使用例: [ユーザーガイド](../user-guide/index.ja.md)
+- 開発への参加: [開発者ガイド](../development/index.ja.md)

{rdetoolkit-1.3.3 → rdetoolkit-1.3.4}/docs/contribute/documents_contributing.md

@@ -30,7 +30,7 @@ rdetoolkitのドキュメントは、本リポジトリの`docs`フォルダに
 以下のURLより、RDEToolKitのリポジトリにアクセスし、issueを発行してください。
 この時、ラベルは`Type:documentation`というラベルを付与してください。
 
-> [RDEToolKit - github.com](https://github.com/nims-dpfc/rdetoolkit/issues)
+> [RDEToolKit - github.com](https://github.com/nims-mdpf/rdetoolkit/issues)
 
 ### ローカル環境で変更する
 

{rdetoolkit-1.3.3 → rdetoolkit-1.3.4}/docs/contribute/home.md

@@ -10,9 +10,9 @@ RDEToolKitへのコントリビュートをしていただくには、以下の
 cd <任意のディレクトリ>
 
 # SSH
-git clone git@github.com:nims-dpfc/rdetoolkit.git
+git clone git@github.com:nims-mdpf/rdetoolkit.git
 # HTTPS
-git clone https://github.com/nims-dpfc/rdetoolkit.git
+git clone https://github.com/nims-mdpf/rdetoolkit.git
 
 # ローカルリポジトリに移動
 cd rdetoolkit

{rdetoolkit-1.3.3 → rdetoolkit-1.3.4}/docs/contribute/sourcecode_contributing.md

@@ -16,7 +16,7 @@
 
 問題や不具合が発生した場合、以下のisuueへ起票お願いします。この時、ラベルは`Type:improvement`, `Type: new feature`のどちらかの付与をお願いします。
 
-> <https://github.com/nims-dpfc/rdetoolkit/issues>
+> <https://github.com/nims-mdpf/rdetoolkit/issues>
 
 ## ブランチの作成
 
@@ -131,4 +131,4 @@ git push origin develop-v<x.y.z>-<先ほどつけた名称>
 
 また、全ての開発がfixしたら、mainブランチにマージしてください。mainブランチにマージ後、デプロイが正しく実行できたら、tagの作成とReleaseページを作成してください。
 
-> Releaseページ: <https://github.com/nims-dpfc/rdetoolkit/releases>
+> Releaseページ: <https://github.com/nims-mdpf/rdetoolkit/releases>