Update README.md

README.md

@@ -10,3 +10,45 @@ The shebang of the script must be replace by  #!/usr/local/bin/python
 
 **Jupyter**
 The shebang of the script must be replace by #!/opt/conda/bin/python
+
+Maap S3 script ins the script used to interact with the bucket S3 to share data with others maap users or to save data when workspace is full.
+Please dont forget the env variable token and maap_env_type
+The script provide following features:
+
+To see all options run maap-s3.py help
+
+    upload used to push the data to S3
+        param 1: sourceFile
+            ex: /projects/test/toto.txt
+        param 2: s3 destination path
+            ex: bmap-catalogue-data/bmaap_test/tkossoko/obs.jar
+        exemple: maap-s3.py upload /projects/test/maap.tiff bmap-catalogue-data/bmaap_test/tkossoko/maap.tiff
+
+    resume use to continue a failed multipart previous upload. When your file is more than 5Giga, the python script use multipart upload. During the process, if the upload fails, please run resume without parameter to continue the upload.
+
+    download to download a data from S3
+        param 1: s3 path
+            ex: bmap-catalogue-data/bmaap_test/demo/maap.tiff
+        param 2: Workspace destination path
+            ex: /projects/test/maap.tiff
+        exemple: maap-s3.py download bmap-catalogue-data/bmaap_test/tkossoko/maap.tiff /projects/test/maap.tiff
+
+    list to list a folder from S3
+        param 1: s3 bucket folder
+            ex: bmap-catalogue-data/bmaap_test/demo
+        exemple: maap-s3.py list bmap-catalogue-data/bmaap_test/demo
+
+    delete to delete a file from S3
+        param 1: s3 file path
+            ex: bmap-catalogue-data/bmaap_test/demo/maap.tiff
+        exemple: s3 delete bmap-catalogue-data/bmaap_test/demo/hello-bjorn.txt
+
+    refresh to reset credentials and passwords when init fails because you type wrong password or email.
+        exemple: maap-s3.py refresh
+
+**1- How to use the script ? **
+
+To call the script, just type maap-s3.py in the console.
+
+Typing maap-s3.py help will show all options available and parameters
+