Skip to content

chore: Add an async support section to the README - #510

Merged
jsonbailey merged 2 commits into
mainfrom
jb/sdk-60/async-readme
Aug 28, 2026
Merged

chore: Add an async support section to the README#510
jsonbailey merged 2 commits into
mainfrom
jb/sdk-60/async-readme

Conversation

@jsonbailey

@jsonbailey jsonbailey commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

What

Adds user-facing docs for the experimental async client, plus a small PR-template aid.

README — new "Async support" section:

  • Experimental caution (matches the .. caution:: blocks on the async API).
  • The redis>=4.2.0 requirement when using Redis with the async client (big segments or persistent store).
  • Install via the [async] extra, and a minimal AsyncLDClient usage example.
  • A Deployment note: AsyncLDClient is single-event-loop / not thread-safe; construct once (its __init__ needs no running loop), then await start() per worker loop — or use async with — which fits ASGI lifespan startup.

PR template: adds a "sync/async parity" checkbox so a change to a sync file prompts a matching async update (the drop-codegen sibling-file convention).

Why

The async implementation is fully merged and importable (from ldclient import AsyncLDClient, [async] extra), but the README had no async entry point. This is the last user-facing gap before an experimental release.

Both files are Markdown, so the test/contract CI is intentionally skipped (paths-ignore: **.md) — there's nothing to test.


Note

Overview
Documents the experimental AsyncLDClient in the README so asyncio users have a clear entry point before an experimental release.

The new Async support section adds production warnings, the launchdarkly-server-sdk[async] install path, a minimal usage example, Redis >=4.2.0 guidance for async Redis, and Event loop notes (single-loop, not thread-safe, construct without a running loop then await start() or async with, ASGI lifespan pattern).

The pull request template gains a sync/async parity checkbox so contributors remember matching async_* siblings when changing sync APIs.

Reviewed by Cursor Bugbot for commit 564868a. Bugbot is set up for automated code reviews on this repo. Configure here.

Document the experimental AsyncLDClient: the caution about its experimental
status, the redis>=4.2 requirement for async Redis, the [async] install
extra, a usage example, and a deployment note (single event loop, construct
once + start per worker loop, ASGI lifespan). Also add a sync/async parity
checkbox to the PR template so changes to a sync file prompt matching async
updates.
@jsonbailey
jsonbailey requested a review from a team as a code owner August 28, 2026 20:34
@jsonbailey jsonbailey changed the title docs: Add an async support section to the README chore: Add an async support section to the README Aug 28, 2026
@jsonbailey
jsonbailey merged commit 4a54e51 into main Aug 28, 2026
5 checks passed
@jsonbailey
jsonbailey deleted the jb/sdk-60/async-readme branch August 28, 2026 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants