diff --git a/README.md b/README.md index a030367..86c8d52 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ datacustomcode run ./payload/entrypoint.py After modifying the `entrypoint.py` as needed, using any dependencies you add in the `.venv` virtual environment, you can run this script in Data Cloud: -**Adding Dependencies**: To add new dependencies: +**To Add New Dependencies**: 1. Make sure your virtual environment is activated 2. Add dependencies to `requirements.txt` 3. Run `pip install -r requirements.txt` @@ -78,15 +78,15 @@ After modifying the `entrypoint.py` as needed, using any dependencies you add in ```zsh datacustomcode scan ./payload/entrypoint.py -datacustomcode deploy --path ./payload --name my_custom_script --compute-type CPU_L +datacustomcode deploy --path ./payload --name my_custom_script --cpu-size CPU_L ``` > [!TIP] > The `deploy` process can take several minutes. If you'd like more feedback on the underlying process, you can add `--debug` to the command like `datacustomcode --debug deploy --path ./payload --name my_custom_script` -> + > [!NOTE] -> **Compute Types**: Choose the appropriate compute type based on your workload requirements: -> - **CPU_L/CPU_XL/CPU_2XL/CPU_4XL**: Large, X-Large, 2X-Large and 4X-Large CPU instances for data processing +> **CPU Size**: Choose the appropriate CPU/Compute Size based on your workload requirements: +> - **CPU_L / CPU_XL / CPU_2XL / CPU_4XL**: Large, X-Large, 2X-Large and 4X-Large CPU instances for data processing > - Default is `CPU_2XL` which provides a good balance of performance and cost for most use cases You can now use the Salesforce Data Cloud UI to find the created Data Transform and use the `Run Now` button to run it. @@ -154,16 +154,6 @@ Options: - `--client-secret TEXT`: Connected App Client Secret - `--login-url TEXT`: Salesforce login URL -#### `datacustomcode deploy` -Deploy a transformation job to Data Cloud. - -Options: -- `--profile TEXT`: Credential profile name (default: "default") -- `--path TEXT`: Path to the code directory (default: ".") -- `--name TEXT`: Name of the transformation job [required] -- `--version TEXT`: Version of the transformation job (default: "0.0.1") -- `--description TEXT`: Description of the transformation job (default: "") -- `--compute-type TEXT`: Compute type for the deployment (default: "CPU_XL"). Available options: CPU_L(Large), CPU_XL (Extra Large), CPU_2XL (2X Large), CPU_4XL (4X Large) #### `datacustomcode init` Initialize a new development environment with a template. @@ -171,6 +161,7 @@ Initialize a new development environment with a template. Argument: - `DIRECTORY`: Directory to create project in (default: ".") + #### `datacustomcode scan` Scan a Python file to generate a Data Cloud configuration. @@ -181,6 +172,7 @@ Options: - `--config TEXT`: Path to save the configuration file (default: same directory as FILENAME) - `--dry-run`: Preview the configuration without saving to a file + #### `datacustomcode run` Run an entrypoint file locally for testing. @@ -191,12 +183,26 @@ Options: - `--config-file TEXT`: Path to configuration file - `--dependencies TEXT`: Additional dependencies (can be specified multiple times) + #### `datacustomcode zip` Zip a transformation job in preparation to upload to Data Cloud. Options: - `--path TEXT`: Path to the code directory (default: ".") + +#### `datacustomcode deploy` +Deploy a transformation job to Data Cloud. + +Options: +- `--profile TEXT`: Credential profile name (default: "default") +- `--path TEXT`: Path to the code directory (default: ".") +- `--name TEXT`: Name of the transformation job [required] +- `--version TEXT`: Version of the transformation job (default: "0.0.1") +- `--description TEXT`: Description of the transformation job (default: "") +- `--cpu-size TEXT`: CPU size for the deployment (default: "CPU_XL"). Available options: CPU_L(Large), CPU_XL(Extra Large), CPU_2XL(2X Large), CPU_4XL(4X Large) + + ## Docker usage The SDK provides Docker-based development options that allow you to test your code in an environment that closely resembles Data Cloud's execution environment. @@ -274,4 +280,5 @@ You now have all fields necessary for the `datacustomcode configure` command. ## Other docs -[Troubleshooting](./docs/troubleshooting.md) +- [Troubleshooting](./docs/troubleshooting.md) +- [For Contributors](./FOR_CONTRIBUTORS.md)