You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: cli/README.md
+17-23
Original file line number
Diff line number
Diff line change
@@ -4,28 +4,12 @@ This Command-Line Interface (CLI) is designed to provide an easy and interactive
4
4
5
5
## Quick Start
6
6
1. Create a batch configuration (ex. `poc.json`) file using the syntax and structure outlined in the [RAI Workflow Framework README](../workflow/README.md).
7
-
2. Add `rai-workflow-manager` as dependency to your `requirements.txt` file:
8
-
```txt
9
-
rai-workflow-manager==0.0.29
10
-
```
11
-
3. Build the project:
7
+
2. Install Python 3.9+ ([Install Python using pyenv](#install-python-using-pyenv)).
8
+
3. Install RWM:
12
9
```bash
13
-
pyenv install 3.9
14
-
pyenv local 3.9
15
-
pip install --upgrade pip
16
-
pip install virtualenv
17
-
python -m virtualenv venv
18
-
source ./venv/bin/activate
19
-
pip install -r requirements.txt
20
-
```
21
-
4. Create main.py file with the following content:
22
-
```python
23
-
import cli.runner
24
-
25
-
if__name__=="__main__":
26
-
cli.runner.start()
10
+
pip install rai-workflow-manager
27
11
```
28
-
5. Create `loader.toml` file with the following content:
12
+
4. Create `loader.toml` file with the following content:
29
13
```toml
30
14
[[container]]
31
15
name="input"
@@ -37,11 +21,10 @@ name="export"
37
21
type="local"
38
22
data_path="./output"
39
23
```
40
-
6. Run the following command to execute the batch configuration:
24
+
5. Run the following command to execute the batch configuration:
41
25
```bash
42
-
python main.py \
26
+
rwm --batch-config poc.json \
43
27
--rel-config-dir <path>/rel \
44
-
--batch-config poc.json \
45
28
--env-config loader.toml \
46
29
--engine <engine> \
47
30
--database <database>
@@ -128,3 +111,14 @@ data_path="./data"
128
111
| Parameter to set timeouts for steps |`--step-timeout`|`False`||`String`| The value should be key value pairs separated by comma. Value must have `int` type. Example: `--step-timeout "step1=10,step2=20"`|
129
112
| Force reimport of sources which are date-partitioned (both chunk and NOT chunk-partitioned) with in `--start-date` & `--end-date` range and all sources which are NOT date-partitioned. |`--force-reimport`|`False`|`False`|`BooleanOptionalAction`|`True` - `--force-reimport`, `False` - `--no-force-reimport`, no argument - default value |
130
113
| Force reimport of sources which are NOT chunk-partitioned. If it's a date-partitioned source, it will be re-imported with in `--start-date` & `--end-date` range. |`--force-reimport-not-chunk-partitioned`|`False`|`False`|`BooleanOptionalAction`|`True` - `--force-reimport-not-chunk-partitioned`, `False` - `--no-force-reimport-not-chunk-partitioned`, no argument - default value |
0 commit comments