48 lines
1.0 KiB
Markdown
48 lines
1.0 KiB
Markdown
# POCloud Driver Setup Utility
|
|
|
|
Developed by Patrick McDonagh, Henry Pump
|
|
|
|
## Installation
|
|
|
|
```pip install .```
|
|
|
|
## Using the driver configurator
|
|
|
|
The driver configurator contains utility functions for manipulating the driver configuration files.
|
|
|
|
ALWAYS BEGIN BY VERIFYING THE CORRECT CONTENTS OF THE driverConfig.json FILE.
|
|
|
|
```bash
|
|
Usage: pocloud_driver_setup [OPTIONS] COMMAND [ARGS]...
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
|
|
Commands:
|
|
prepare Perform the configuration of the driver.
|
|
upload Upload the file to AWS S3 bucket.
|
|
```
|
|
|
|
### Prepare Function
|
|
|
|
```bash
|
|
Usage: pocloud_driver_setup prepare [OPTIONS]
|
|
|
|
Perform the configuration of the driver.
|
|
|
|
Options:
|
|
--dry-run TEXT Perform a dry run of the script without making changes
|
|
--version TEXT Sets the version number of the driver code
|
|
--help Show this message and exit.
|
|
```
|
|
|
|
### Upload Function
|
|
|
|
```bash
|
|
Usage: pocloud_driver_setup upload [OPTIONS]
|
|
|
|
Upload the file to AWS S3 bucket.
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
``` |