Clarifying Connect methods docs

Author: jaidisido

awswrangler/mysql.py

@@ -82,6 +82,19 @@ def connect(
 
     https://pymysql.readthedocs.io
 
+    Note
+    ----
+    You MUST pass a `connection` OR `secret_id`.
+    Here is an example of the secret structure in Secrets Manager:
+    {
+    "host":"mysql-instance-wrangler.dr8vkeyrb9m1.us-east-1.rds.amazonaws.com",
+    "username":"test",
+    "password":"test",
+    "engine":"mysql",
+    "port":"3306",
+    "dbname": "mydb" # Optional
+    }
+
     Note
     ----
     It is only possible to configure SSL using Glue Catalog Connection. More at:
@@ -92,7 +105,7 @@ def connect(
     connection : str
         Glue Catalog Connection name.
     secret_id: Optional[str]:
-        Specifies the secret containing the version that you want to retrieve.
+        Specifies the secret containing the connection details that you want to retrieve.
         You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
     catalog_id : str, optional
         The ID of the Data Catalog.

awswrangler/postgresql.py

@@ -86,12 +86,25 @@ def connect(
 
     https://github.com/tlocke/pg8000
 
+    Note
+    ----
+    You MUST pass a `connection` OR `secret_id`.
+    Here is an example of the secret structure in Secrets Manager:
+    {
+    "host":"postgresql-instance-wrangler.dr8vkeyrb9m1.us-east-1.rds.amazonaws.com",
+    "username":"test",
+    "password":"test",
+    "engine":"postgresql",
+    "port":"3306",
+    "dbname": "mydb" # Optional
+    }
+
     Parameters
     ----------
     connection : Optional[str]
         Glue Catalog Connection name.
     secret_id: Optional[str]:
-        Specifies the secret containing the version that you want to retrieve.
+        Specifies the secret containing the connection details that you want to retrieve.
         You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
     catalog_id : str, optional
         The ID of the Data Catalog.

awswrangler/redshift.py

@@ -398,7 +398,7 @@ def connect(
     connection : Optional[str]
         Glue Catalog Connection name.
     secret_id: Optional[str]:
-        Specifies the secret containing the version that you want to retrieve.
+        Specifies the secret containing the connection details that you want to retrieve.
         You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
     catalog_id : str, optional
         The ID of the Data Catalog.

awswrangler/sqlserver.py

@@ -113,12 +113,25 @@ def connect(
 
     https://github.com/mkleehammer/pyodbc
 
+    Note
+    ----
+    You MUST pass a `connection` OR `secret_id`.
+    Here is an example of the secret structure in Secrets Manager:
+    {
+    "host":"sqlserver-instance-wrangler.dr8vkeyrb9m1.us-east-1.rds.amazonaws.com",
+    "username":"test",
+    "password":"test",
+    "engine":"sqlserver",
+    "port":"1433",
+    "dbname": "mydb" # Optional
+    }
+
     Parameters
     ----------
     connection : Optional[str]
         Glue Catalog Connection name.
     secret_id: Optional[str]:
-        Specifies the secret containing the version that you want to retrieve.
+        Specifies the secret containing the connection details that you want to retrieve.
         You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
     catalog_id : str, optional
         The ID of the Data Catalog.

pyproject.toml

@@ -85,7 +85,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.black]
 line-length = 120
 target-version = ["py36", "py37", "py38", "py39"]
-exclude = '''
+extend_exclude = '''
 /(
     \.eggs
   | \.git