Command Line Interface
Overview
RDEToolKit provides a comprehensive command-line interface to support the development and execution of RDE structured processing. It supports the entire development workflow from project initialization to Excel invoice generation and archive creation.
Prerequisites
- Python 3.9 or higher
- rdetoolkit package installation
Available Commands
init: Create Startup Project
Creates a startup project for RDE structured processing.
1 |
|
1 |
|
The following directories and files will be generated:
1 2 3 4 5 6 7 8 9 10 11 |
|
Description of each file:
- requirements.txt: Add Python packages you want to use for structured program construction. Run
pip install
as needed. - modules: Store programs you want to use for structured processing.
- main.py: Define startup processing for structured programs
- data/inputdata: Place data files to be processed by structured processing.
- data/invoice: Required for local execution, even if empty.
- data/tasksupport: Place files that support structured processing.
File Overwriting
Existing files will be skipped from overwriting or generation.
make_excelinvoice: Generate Excel Invoice
Generates an Excel invoice from invoice.schema.json
.
1 |
|
1 |
|
Options
Option | Description | Required |
---|---|---|
-o(--output) | Output file path. The file path should end with _excel_invoice.xlsx . |
○ |
-m | Mode selection. Choose registration mode. You can select file mode file or folder mode folder . |
- |
Default Output
If -o
is not specified, it will be created as template_excel_invoice.xlsx
in the execution directory.
version: Version Check
Check the version of rdetoolkit.
1 |
|
1 |
|
artifact: Create RDE Submission Archive
Creates an archive (.zip) for submission to RDE. Compresses the specified source directory and excludes files or directories that match exclusion patterns.
1 |
|
1 |
|
Options
Option | Description | Required |
---|---|---|
-s(--source-dir) | Source directory to compress and scan | ○ |
-o(--output-archive) | Output archive file (e.g., rde_template.zip) | - |
-e(--exclude) | Directory names to exclude. By default, 'venv' and 'site-packages' are excluded | - |
Execution Report
When an archive is created, the following execution report is generated:
- Existence check of Dockerfile and requirements.txt
- List of included directories and files
- Code scan results (security risk detection)
- External communication check results
Sample execution report:
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 |
|
Option Details
- If
--output-archive
is not specified, an archive will be created with a default filename. - The
--exclude
option can be specified multiple times (e.g.,--exclude venv --exclude .git
).
Next Steps
- Understand Structured Processing Concepts
- Learn how to create Configuration Files
- Check detailed features in API Reference