diff --git a/test/README.md b/test/README.md index c414149..e57b773 100644 --- a/test/README.md +++ b/test/README.md @@ -1,8 +1,18 @@ # Blob Utils +List, Upload and Download files for Canone Unico on Azure Blob Storage. + +## Prerequisites + +Before to use this tool, type this command: + +`az login` + +--- + ## List -Shows the list of the files in a blob storage. +To show the list of the files in a blob storage. Default list the input container of develop. `python3 ./blob_utils.py list` @@ -13,16 +23,22 @@ Optional --container_name {name of the container} ``` -Example: +### Examples `python3 ./blob_utils.py list --account-name pagopadcanoneunicosa --container_name pagopadcanoneunicosaincsvcontainer` +--- + ## Download -Downloads a file from a blob storage. +To download a file from a blob storage. `python3 ./blob_utils.py download --file {name of the file in the blob storage}` +**Required** + +`--file {name of the file to upload}` + Optional ``` @@ -31,16 +47,22 @@ Optional --container_name {name of the container} ``` -Example: +### Examples `python3 ./blob_utils.py download --file filename.csv --path out --account-name pagopadcanoneunicosa --container_name pagopadcanoneunicosaincsvcontainer` +--- + ## Upload -Uploads a file in the blob storage. If `rows` is set it creates a CSV file with fake data first. +To upload a file in the blob storage. If `rows` is set it creates a CSV file with fake data first. `python3 ./blob_utils.py upload --file {name of the file to upload}` +**Required** + +`--file {name of the file to upload}` + Optional ``` @@ -50,6 +72,12 @@ Optional --container_name {name of the container} ``` -Example: +### Examples + +- with auto generation of the file (with --rows parameter) `python3 ./blob_utils.py upload --file filename.csv --rows 5 --path in --account-name pagopadcanoneunicosa --container_name pagopadcanoneunicosaincsvcontainer` + +- to upload an existing file (without --rows parameter) + +`python3 ./blob_utils.py upload --file filename.csv --path in --account-name pagopadcanoneunicosa --container_name pagopadcanoneunicosaincsvcontainer`