updated readme for all modules

quxdev · Jan 30, 2023 · d08e28d · d08e28d
1 parent e5ad29b
commit d08e28d
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 7 deletions.
diff --git a/Q3/README.md b/Q3/README.md
@@ -8,8 +8,8 @@
 ## Install
 1. install dependencies
 2. Add the following to your .env file
-    AWS_ACCESS_KEY_ID = ""
-    AWS_SECRET_ACCESS_KEY = ""
+    AWS_S3_ACCESS_KEY_ID = ""
+    AWS_S3_SECRET_ACCESS_KEY = ""
 
 ## Usage
 

diff --git a/q3managed/README.md b/q3managed/README.md
@@ -5,6 +5,17 @@
 django - for the data models
 q3 - for accessing S3
 ```
+## Install dependencies and create database models
+```
+pip install s3fs
+pip install pandas
+
+python manage.py migrate qws 
+
+Add the following to your .env file
+    AWS_S3_ACCESS_KEY_ID = ""
+    AWS_S3_SECRET_ACCESS_KEY = ""
+```
 
 ## Usage
 ```
@@ -48,8 +59,9 @@ df = q3m.exists(fileurl)
 
 ### Find Files => returns a list of dict [{'url' : 's3://enine-test/mapping.csv', 'report_name': 'test'}]
 ```
-fileurl = "s3://enine-test/mapping.csv"
-filelist = q3m.download_df(fileurl)
+prefix = "s3://enine-test"
+tags = {'report_id' : '1'}
+filelist = q3m.find(prefix, tags)
 ```
 
 ### Add Tags to existing files => returns True if success else None. Override existing tags or add new using the override param.

diff --git a/qec2/README.md b/qec2/README.md
@@ -6,7 +6,11 @@
 
 ## Install
 1. install dependencies
-2. Add the following to your .env file
+```
+pip install boto3
+```
+
+2. Add the following to your .env file.
     AWS_ACCESS_KEY_ID = ""
     AWS_SECRET_ACCESS_KEY = ""
 

diff --git a/qses/README.md b/qses/README.md
@@ -6,9 +6,13 @@
 
 ## Install
 1. install dependencies
+```
+pip install boto3
+```
+
 2. Add the following to your .env file
-    AWS_ACCESS_KEY_ID = ""
-    AWS_SECRET_ACCESS_KEY = ""
+    AWS_SES_ACCESS_KEY_ID = ""
+    AWS_SES_SECRET_ACCESS_KEY = ""
     AWS_REGION = ""
 
 ## Usage