Skip to content

Commit 2f3d434

Browse files
authored
docs: updating python requirement and envrionment varaiable information (#900)
1 parent 383b605 commit 2f3d434

File tree

4 files changed

+8
-10
lines changed

4 files changed

+8
-10
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,8 @@ with AwsWrapperConnection.connect(
4949
) as awsconn:
5050
awscursor = awsconn.cursor()
5151
awscursor.execute("SELECT aurora_db_instance_identifier()")
52-
awscursor.fetchone()
53-
for record in awscursor:
54-
print(record)
52+
row = awscursor.fetchone()
53+
print(row)
5554
```
5655
The `AwsWrapperConnection#connect` method accepts the connection configuration through both the connection string and the keyword arguments.
5756

@@ -72,9 +71,8 @@ with AwsWrapperConnection.connect(
7271
) as awsconn:
7372
awscursor = awsconn.cursor()
7473
awscursor.execute("SELECT @@aurora_server_id")
75-
awscursor.fetchone()
76-
for record in awscursor:
77-
print(record)
74+
row = awscursor.fetchone()
75+
print(row)
7876
```
7977

8078
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
201199

202200
1. Set up your environment by following the directions in the [Development Guide](./docs/development-guide/DevelopmentGuide.md).
203201
2. To contribute, first make a fork of this project.
204-
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).
202+
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)).
205203
4. Create a pull request from your fork.
206204
5. Pull requests need to be approved and merged by maintainers into the main branch. <br />
207205

docs/GettingStarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Before using the AWS Advanced Python Driver, you must install:
66

7-
- Python 3.8+.
7+
- Python 3.8 - 3.11 (inclusive).
88
- The AWS Advanced Python Driver.
99
- Your choice of underlying Python driver.
1010
- To use the wrapper with Aurora with PostgreSQL compatibility, install [Psycopg](https://github.com/psycopg/psycopg).

docs/development-guide/DevelopmentGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Development Guide
22

33
### Setup
4-
Make sure you have Python 3.8+ installed, along with your choice of underlying Python driver (see [minimum requirements](../GettingStarted.md#minimum-requirements)).
4+
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)).
55

66
Clone the AWS Advanced Python Driver repository:
77

docs/development-guide/IntegrationTests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ unset FILTER # Done testing the IAM tests, unset FILTER
117117

118118
| Environment Variable Name | Required | Description | Example Value |
119119
|---------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
120-
| `DB_USER` | Yes | The username to access the database. | `admin` |
120+
| `DB_USERNAME` | Yes | The username to access the database. | `admin` |
121121
| `DB_PASSWORD` | Yes | The database cluster password. | `password` |
122122
| `DB_DATABASE_NAME` | No | Name of the database that will be used by the tests. The default database name is test. | `test_db_name` |
123123
| `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` |

0 commit comments

Comments
 (0)