コマンドライン機能について
init: スタートアッププロジェクトの作成
以下のコマンドで、RDE構造化処理のスタートアッププロジェクトを作成することができます。
1 |
|
1 |
|
以下のディレクトリとファイル群が生成されます。
1 2 3 4 5 6 7 8 9 10 11 |
|
各ファイルの説明は以下の通りです。
- requirements.txt
- 構造化プログラム構築で使用したいPythonパッケージを追加してください。必要に応じて
pip install
を実行してください。
- 構造化プログラム構築で使用したいPythonパッケージを追加してください。必要に応じて
- modules
- 構造化処理で使用したいプログラムを格納してください。別セクションで説明します。
- main.py
- 構造化プログラムの起動処理を定義
- data/inputdata
- 構造化処理対象データファイルを配置してください。
- data/invoice
- ローカル実行させるためには空ファイルでも必要になります。
- data/tasksupport
- 構造化処理の補助するファイル群を配置してください。
Tip
すでに存在するファイルは上書きや生成がスキップされます。
ExcelInvoiceの生成機能について
make_excelinvoice
で、invoic.schema.json
からExcelinvoiceを生成可能です。利用可能なオプションは以下の通りです。
オプション | 説明 | 必須 |
---|---|---|
-o(--output) | 出力ファイルパス。ファイルパスの末尾は_excel_invoice.xlsx を付与すること。 |
o |
-m | モードの選択。登録モードの選択。ファイルモードfile かフォルダモードfolder を選択可能。 |
- |
1 |
|
1 |
|
Tip
-o
を指定しない場合は、template_excel_invoice.xlsx
というファイル名で、実行ディレクトリ配下に作成されます。
version: バージョン確認
以下のコマンドで、rdetoolkitのバージョンを確認することができます。
1 |
|
1 |
|
artifact: RDE提出用アーカイブの作成
artifact
コマンドを使用して、RDEに提出するためのアーカイブ(.zip)を作成することができます。指定したソースディレクトリを圧縮し、除外パターンに一致するファイルやディレクトリを除外します。
1 |
|
1 |
|
利用可能なオプションは以下の通りです。
オプション | 説明 | 必須 |
---|---|---|
-s(--source-dir) | 圧縮・スキャン対象のソースディレクトリ | o |
-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 25 26 |
|
External Communication Check Results
container/external.py
1 2 3 4 5 |
|
Tip
--output-archive
を指定しない場合、デフォルトのファイル名でアーカイブが作成されます。
--exclude
オプションは複数回指定することができます(例:--exclude venv --exclude .git
)。