コマンドライン機能について
概要
RDEToolKitは、RDE構造化処理の開発と実行を支援する包括的なコマンドラインインターフェースを提供します。プロジェクトの初期化から、Excelインボイスの生成、アーカイブの作成まで、開発ワークフロー全体をサポートします。
前提条件
- Python 3.9以上
- rdetoolkitパッケージのインストール
利用可能なコマンド
init: スタートアッププロジェクトの作成
RDE構造化処理のスタートアッププロジェクトを作成します。
1 |
|
1 |
|
以下のディレクトリとファイル群が生成されます。
1 2 3 4 5 6 7 8 9 10 11 |
|
各ファイルの説明は以下の通りです。
- requirements.txt: 構造化プログラム構築で使用したいPythonパッケージを追加してください。必要に応じて
pip install
を実行してください。 - modules: 構造化処理で使用したいプログラムを格納してください。
- main.py: 構造化プログラムの起動処理を定義
- data/inputdata: 構造化処理対象データファイルを配置してください。
- data/invoice: ローカル実行させるためには空ファイルでも必要になります。
- data/tasksupport: 構造化処理の補助するファイル群を配置してください。
ファイル上書きについて
すでに存在するファイルは上書きや生成がスキップされます。
make_excelinvoice: ExcelInvoiceの生成
invoice.schema.json
からExcelインボイスを生成します。
1 |
|
1 |
|
オプション
オプション | 説明 | 必須 |
---|---|---|
-o(--output) | 出力ファイルパス。ファイルパスの末尾は_excel_invoice.xlsx を付与すること。 |
○ |
-m | モードの選択。登録モードの選択。ファイルモードfile かフォルダモードfolder を選択可能。 |
- |
デフォルト出力
-o
を指定しない場合は、template_excel_invoice.xlsx
というファイル名で、実行ディレクトリ配下に作成されます。
version: バージョン確認
rdetoolkitのバージョンを確認します。
1 |
|
1 |
|
artifact: RDE提出用アーカイブの作成
RDEに提出するためのアーカイブ(.zip)を作成します。指定したソースディレクトリを圧縮し、除外パターンに一致するファイルやディレクトリを除外します。
1 |
|
1 |
|
オプション
オプション | 説明 | 必須 |
---|---|---|
-s(--source-dir) | 圧縮・スキャン対象のソースディレクトリ | ○ |
-o(--output-archive) | 出力アーカイブファイル(例:rde_template.zip) | - |
-e(--exclude) | 除外するディレクトリ名。デフォルトでは 'venv' と 'site-packages' が除外されます | - |
実行レポート
アーカイブが作成されると、以下のような実行レポートが生成されます:
- Dockerfileやrequirements.txtの存在確認
- 含まれるディレクトリとファイルのリスト
- コードスキャン結果(セキュリティリスクの検出)
- 外部通信チェック結果
実行レポートのサンプル:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
External Communication Check Results
container/external.py
1 2 3 4 5 |
|
オプション詳細
--output-archive
を指定しない場合、デフォルトのファイル名でアーカイブが作成されます。--exclude
オプションは複数回指定することができます(例:--exclude venv --exclude .git
)。