chore: Document the async-dynamodb extra in the README - #514
Merged
Merged
Conversation
Async DynamoDB uses a separate 'async-dynamodb' extra (aioboto3), distinct from the synchronous 'dynamodb' extra; note it alongside the async Redis note.
jsonbailey
marked this pull request as ready for review
September 3, 2026 13:22
jsonbailey
changed the title
joker23
approved these changes
Sep 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Async DynamoDB uses a separate
async-dynamodbextra (aioboto3), distinct from the synchronousdynamodbextra. The README's async persistent-store note only covered async Redis; this adds the DynamoDB equivalent so users install the right extra:Part of the async SDK documentation follow-up (SDK-2879). The async surface shipped experimentally in 9.17.0.
Note
Overview
Extends the Async support caution/note block so DynamoDB persistent stores are covered alongside the existing Redis guidance.
The new note states that async DynamoDB needs the
async-dynamodboptional extra (aioboto3), not the synchronousdynamodbextra, and showspip install launchdarkly-server-sdk[async,async-dynamodb]so users avoid installing the wrong dependency when usingAsyncLDClientwith DynamoDB.Reviewed by Cursor Bugbot for commit 09e5158. Bugbot is set up for automated code reviews on this repo. Configure here.