chore: bump version to 1.0.0 (#551)

Author: karenc-bq

CHANGELOG.md

@@ -1,4 +1,4 @@
-## [1.0.0] - 2024-05-16
+## [1.0.0] - 2024-05-23
 The Amazon Web Services (AWS) Advanced Python Wrapper allows an application to take advantage of the features of clustered Aurora databases.
 
 ### :magic_wand: Added

README.md

@@ -1,7 +1,7 @@
 # Amazon Web Services (AWS) Advanced Python Driver
 
-[![Build Status](https://github.com/awslabs/aws-advanced-python-wrapper/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/awslabs/aws-advanced-python-wrapper/actions/workflows/main.yml)
-[![Integration Tests](https://github.com/awslabs/aws-advanced-python-wrapper/actions/workflows/integration_tests.yml/badge.svg?branch=main)](https://github.com/awslabs/aws-advanced-python-wrapper/actions/workflows/integration_tests.yml)
+[![Python Check and Unit Test](https://github.com/aws/aws-advanced-python-wrapper/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/aws/aws-advanced-python-wrapper/actions/workflows/main.yml)
+[![Integration Tests](https://github.com/aws/aws-advanced-python-wrapper/actions/workflows/integration_tests.yml/badge.svg)](https://github.com/aws/aws-advanced-python-wrapper/actions/workflows/integration_tests.yml)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 
 ## About the Driver
@@ -158,8 +158,15 @@ In the event of a network failure where the host can no longer be reached, the `
 
 The official MySQL Connector/Python [offers a Python implementation and a C implementation](https://dev.mysql.com/doc/connector-python/en/connector-python-example-connecting.html#:~:text=Using%20the%20Connector/Python%20Python%20or%20C%20Extension) of the driver that can be toggled using the `use_pure` connection argument.
 The [IAM Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) is incompatible with the Python implementation of the driver due to its 255-character password limit.
-The IAM Authentication Plugin generates a temporary AWS IAM token to authenticate users. Passing this token to the Python implementation of the driver will result in the following error:
-`struct.error: ubyte format requires 0 <= number <= 255`. To avoid this error, we recommend you set `use_pure` to `False` when using the IAM Authentication Plugin.
+The IAM Authentication Plugin generates a temporary AWS IAM token to authenticate users. Passing this token to the Python implementation of the driver will result in error messages similar to the following:
+```
+Error occurred while opening a connection: int1store requires 0 <= i <= 255
+```
+or 
+```
+struct.error: ubyte format requires 0 <= number <= 255
+```
+To avoid this error, we recommend you set `use_pure` to `False` when using the IAM Authentication Plugin.
 However, as noted in the [MySQL Connector/Python C Extension](#mysql-connectorpython-c-extension) section, doing so may cause the application to indefinitely hang if there is a network failure.
 Unfortunately, due to conflicting limitations, you will need to decide if using the IAM plugin is worth this risk for your application.
 

docs/README.md

@@ -4,19 +4,25 @@
 - [Using the AWS Python Driver](./using-the-python-driver/UsingThePythonDriver.md)
   - [Logging](./using-the-python-driver/UsingThePythonDriver.md#logging)
   - [Python Wrapper Parameters](./using-the-python-driver/UsingThePythonDriver.md#aws-advanced-python-driver-parameters)
+  - [Support For RDS Multi-AZ Database Cluster](./using-the-python-driver/SupportForRDSMultiAzDBCluster.md)
+  - [Session State](./using-the-python-driver/SessionState.md)
   - [Database Dialects](./using-the-python-driver/DatabaseDialects.md)
-  - [Target Driver Dialects](./using-the-python-driver/DriverDialects.md)
-  - [Plugins](./using-the-python-driver/UsingThePythonDriver.md#plugins)
-    - [Failover Plugin](./using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md)
-      - [Failover Configuration Guide](./using-the-python-driver/FailoverConfigurationGuide.md)
-    - [Federated Authentication Plugin](./using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md)
-    - [Host Monitoring Plugin](./using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md)
-    - [IAM Authentication Plugin](./using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)
-    - [AWS Secrets Manager Plugin](./using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
-    - [Aurora Connection Tracker Plugin](./using-the-python-driver/using-plugins/UsingTheAuroraConnectionTrackerPlugin.md)
-    - [Read Write Splitting Plugin](./using-the-python-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md)
-    - [Fastest Response Strategy Plugin](./using-the-python-driver/using-plugins/UsingTheFastestResponseStrategyPlugin.md)
-  - [Host Availability Strategy](./using-the-python-driver/HostAvailabilityStrategy.md)
+  - [Driver Dialects](./using-the-python-driver/DriverDialects.md)
+  - [Telemetry](./using-the-python-driver/Telemetry.md)
+    - [Plugins](./using-the-python-driver/UsingThePythonDriver.md#plugins)
+      - [Failover Plugin](./using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md)
+        - [Failover Configuration Guide](./using-the-python-driver/FailoverConfigurationGuide.md)
+      - [Host Monitoring Plugin](./using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md)
+      - [Aurora Connection Tracker Plugin](./using-the-python-driver/using-plugins/UsingTheAuroraConnectionTrackerPlugin.md)
+      - [Aurora Initial Connection Strategy Plugin](./using-the-python-driver/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md)
+        - [Host Availability Strategy](./using-the-python-driver/HostAvailabilityStrategy.md)
+      - [IAM Authentication Plugin](./using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)
+      - [AWS Secrets Manager Plugin](./using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
+      - [Federated Authentication Plugin](./using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md)
+      - [Read Write Splitting Plugin](./using-the-python-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md)
+        - [Reader Selection Strategies](./using-the-python-driver/ReaderSelectionStrategies.md)
+      - [Fastest Response Strategy Plugin](./using-the-python-driver/using-plugins/UsingTheFastestResponseStrategyPlugin.md)
+    - [Host Availability Strategy](./using-the-python-driver/HostAvailabilityStrategy.md)
 - [Development Guide](./development-guide/DevelopmentGuide.md)
   - [Setup](./development-guide/DevelopmentGuide.md#setup)
   - [Testing Overview](./development-guide/DevelopmentGuide.md#testing-overview)

docs/examples/MySQLReadWriteSplitting.py

@@ -40,8 +40,8 @@ def get_pool_key(host_info: HostInfo, props: Dict[str, Any]) -> str:
     # Include the URL, user, and database in the connection pool key so that a new
     # connection pool will be opened for each different instance-user-database combination.
     url = host_info.url
-    user = props["username"]
-    db = props["dbname"]
+    user = props["user"]
+    db = props["database"]
     return f"{url}{user}{db}"
 
 

docs/examples/PGReadWriteSplitting.py

@@ -40,7 +40,7 @@ def get_pool_key(host_info: HostInfo, props: Dict[str, Any]) -> str:
     # Include the URL, user, and database in the connection pool key so that a new
     # connection pool will be opened for each different instance-user-database combination.
     url = host_info.url
-    user = props["username"]
+    user = props["user"]
     db = props["dbname"]
     return f"{url}{user}{db}"
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aws_advanced_python_wrapper"
-version = "1.0.0rc2"
+version = "1.0.0"
 description = "Amazon Web Services (AWS) Advanced Python Wrapper"
 authors = ["Amazon Web Services"]
 readme = "README.md"