Skip to content

docs: updating python requirement and envrionment varaiable information #900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 12, 2025
Merged

docs: updating python requirement and envrionment varaiable information #900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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,
Expand Down Expand Up @@ -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. <br />

Expand Down
2 changes: 1 addition & 1 deletion docs/GettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion docs/development-guide/DevelopmentGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/development-guide/IntegrationTests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down