Skip to content

Commit f75fbdc

Browse files
committed
chore: allow creation of replane client without connection options
1 parent 51747d0 commit f75fbdc

2 files changed

Lines changed: 24 additions & 12 deletions

File tree

replane/_async.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -287,19 +287,25 @@ class AsyncReplane(Generic[ConfigsT]):
287287
Replane's codegen feature. When provided, it enables better type inference
288288
for config values accessed via the ``configs`` property.
289289
290-
Example:
290+
Example with context manager (recommended):
291291
>>> async with AsyncReplane(
292292
... base_url="https://replane.example.com",
293293
... sdk_key="rp_...",
294294
... ) as replane:
295295
... value = replane.configs["feature-flag"]
296296
297-
Or with manual lifecycle:
298-
>>> replane = AsyncReplane(...)
297+
Without context manager (credentials in constructor):
298+
>>> replane = AsyncReplane(base_url="...", sdk_key="...")
299299
>>> await replane.connect()
300300
>>> value = replane.configs["feature-flag"]
301301
>>> await replane.close()
302302
303+
Without context manager (credentials in connect):
304+
>>> replane = AsyncReplane()
305+
>>> await replane.connect(base_url="...", sdk_key="...")
306+
>>> value = replane.configs["feature-flag"]
307+
>>> await replane.close()
308+
303309
With generated types for better type safety (recommended):
304310
>>> from replane_types import Configs
305311
>>> async with AsyncReplane[Configs](...) as replane:

replane/_sync.py

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -289,19 +289,25 @@ class Replane(Generic[ConfigsT]):
289289
Replane's codegen feature. When provided, it enables better type inference
290290
for config values accessed via the ``configs`` property.
291291
292-
Example:
293-
>>> client = Replane(
292+
Example with context manager (recommended):
293+
>>> with Replane(
294294
... base_url="https://replane.example.com",
295295
... sdk_key="rp_...",
296-
... )
297-
>>> client.connect()
298-
>>> value = client.get("feature-flag")
299-
>>> client.close()
300-
301-
For simpler usage, prefer the context manager:
302-
>>> with Replane(...) as replane:
296+
... ) as replane:
303297
... value = replane.configs["feature-flag"]
304298
299+
Without context manager (credentials in constructor):
300+
>>> replane = Replane(base_url="...", sdk_key="...")
301+
>>> replane.connect()
302+
>>> value = replane.configs["feature-flag"]
303+
>>> replane.close()
304+
305+
Without context manager (credentials in connect):
306+
>>> replane = Replane()
307+
>>> replane.connect(base_url="...", sdk_key="...")
308+
>>> value = replane.configs["feature-flag"]
309+
>>> replane.close()
310+
305311
With generated types for better type safety (recommended):
306312
>>> from replane_types import Configs
307313
>>> with Replane[Configs](...) as replane:

0 commit comments

Comments
 (0)