From ec4d30f1c8d2146246a0426ad3f33efff31161a9 Mon Sep 17 00:00:00 2001 From: Juan Lee Date: Thu, 12 Jun 2025 11:32:34 -0700 Subject: [PATCH] docs: updating python requirement and envrionment varaiable information --- README.md | 12 +++++------- docs/GettingStarted.md | 2 +- docs/development-guide/DevelopmentGuide.md | 2 +- docs/development-guide/IntegrationTests.md | 2 +- 4 files changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5c5778806..b1c7c5f4d 100644 --- a/README.md +++ b/README.md @@ -49,9 +49,8 @@ with AwsWrapperConnection.connect( ) as awsconn: awscursor = awsconn.cursor() awscursor.execute("SELECT aurora_db_instance_identifier()") - awscursor.fetchone() - for record in awscursor: - print(record) + row = awscursor.fetchone() + print(row) ``` The `AwsWrapperConnection#connect` method accepts the connection configuration through both the connection string and the keyword arguments. @@ -72,9 +71,8 @@ with AwsWrapperConnection.connect( ) as awsconn: awscursor = awsconn.cursor() awscursor.execute("SELECT @@aurora_server_id") - awscursor.fetchone() - for record in awscursor: - print(record) + row = awscursor.fetchone() + print(row) ``` For more details on how to download the AWS Advanced Python Driver, minimum requirements to use it, @@ -201,7 +199,7 @@ For all other questions, please use [GitHub discussions](https://github.com/awsl 1. Set up your environment by following the directions in the [Development Guide](./docs/development-guide/DevelopmentGuide.md). 2. To contribute, first make a fork of this project. -3. Make any changes on your fork. Make sure you are aware of the requirements for the project (e.g. do not require Python 3.7 if we are supporting Python 3.8 and higher). +3. Make any changes on your fork. Make sure you are aware of the requirements for the project (e.g. do not require Python 3.7 if we are supporting Python 3.8 - 3.11 (inclusive)). 4. Create a pull request from your fork. 5. Pull requests need to be approved and merged by maintainers into the main branch.
diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index d352f52ec..1e372f8d5 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -4,7 +4,7 @@ Before using the AWS Advanced Python Driver, you must install: -- Python 3.8+. +- Python 3.8 - 3.11 (inclusive). - The AWS Advanced Python Driver. - Your choice of underlying Python driver. - To use the wrapper with Aurora with PostgreSQL compatibility, install [Psycopg](https://github.com/psycopg/psycopg). diff --git a/docs/development-guide/DevelopmentGuide.md b/docs/development-guide/DevelopmentGuide.md index 2f7d32759..578132fd3 100644 --- a/docs/development-guide/DevelopmentGuide.md +++ b/docs/development-guide/DevelopmentGuide.md @@ -1,7 +1,7 @@ # Development Guide ### Setup -Make sure you have Python 3.8+ installed, along with your choice of underlying Python driver (see [minimum requirements](../GettingStarted.md#minimum-requirements)). +Make sure you have Python 3.8 - 3.11 (inclusive) installed, along with your choice of underlying Python driver (see [minimum requirements](../GettingStarted.md#minimum-requirements)). Clone the AWS Advanced Python Driver repository: diff --git a/docs/development-guide/IntegrationTests.md b/docs/development-guide/IntegrationTests.md index 5dca571c1..e8d63089a 100644 --- a/docs/development-guide/IntegrationTests.md +++ b/docs/development-guide/IntegrationTests.md @@ -117,7 +117,7 @@ unset FILTER # Done testing the IAM tests, unset FILTER | Environment Variable Name | Required | Description | Example Value | |---------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| -| `DB_USER` | Yes | The username to access the database. | `admin` | +| `DB_USERNAME` | Yes | The username to access the database. | `admin` | | `DB_PASSWORD` | Yes | The database cluster password. | `password` | | `DB_DATABASE_NAME` | No | Name of the database that will be used by the tests. The default database name is test. | `test_db_name` | | `RDS_CLUSTER_NAME` | Yes | The database identifier for your Aurora or RDS cluster. Must be a unique value to avoid conflicting with existing clusters. | `db-identifier` |