Skip to content

Commit fc1ac87

Browse files
committed
chore: update docs
1 parent 56b23bc commit fc1ac87

9 files changed

Lines changed: 29 additions & 29 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Requires `pip install replane[async]`:
5959
from replane import AsyncReplane
6060

6161
async with AsyncReplane(
62-
base_url="https://replane.example.com",
62+
base_url="https://cloud.replane.dev",
6363
sdk_key="rp_...",
6464
) as replane:
6565
# Access configs from local cache
@@ -138,7 +138,7 @@ Both clients accept the same configuration:
138138

139139
```python
140140
replane = Replane(
141-
base_url="https://replane.example.com",
141+
base_url="https://cloud.replane.dev",
142142
sdk_key="rp_...",
143143

144144
# Default context applied to all config evaluations
@@ -402,7 +402,7 @@ _replane: AsyncReplane | None = None
402402
async def lifespan(app: FastAPI):
403403
global _replane
404404
_replane = AsyncReplane(
405-
base_url="https://replane.example.com",
405+
base_url="https://cloud.replane.dev",
406406
sdk_key="rp_...",
407407
)
408408
await _replane.connect()
@@ -437,7 +437,7 @@ _replane: Replane | None = None
437437
def init_replane():
438438
global _replane
439439
_replane = Replane(
440-
base_url="https://replane.example.com",
440+
base_url="https://cloud.replane.dev",
441441
sdk_key="rp_...",
442442
)
443443
_replane.connect()

docs/source/configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ from replane import Replane
1111

1212
replane = Replane(
1313
# Can be provided here or in connect()
14-
base_url="https://replane.example.com",
14+
base_url="https://cloud.replane.dev",
1515
sdk_key="rp_...",
1616

1717
# Optional
@@ -37,11 +37,11 @@ The base URL of your Replane server. Can be provided in the constructor or in `c
3737

3838
```python
3939
# In constructor
40-
replane = Replane(base_url="https://replane.example.com", sdk_key="...")
40+
replane = Replane(base_url="https://cloud.replane.dev", sdk_key="...")
4141

4242
# Or in connect()
4343
replane = Replane(sdk_key="...")
44-
replane.connect(base_url="https://replane.example.com")
44+
replane.connect(base_url="https://cloud.replane.dev")
4545
```
4646

4747
#### `sdk_key`
@@ -213,9 +213,9 @@ When enabled, you'll see logs for:
213213
Example output:
214214

215215
```
216-
2024-01-15 10:30:00 [DEBUG] replane: Initializing Replane: base_url=https://replane.example.com, ...
216+
2024-01-15 10:30:00 [DEBUG] replane: Initializing Replane: base_url=https://cloud.replane.dev, ...
217217
2024-01-15 10:30:00 [DEBUG] replane: connect() called, wait=True
218-
2024-01-15 10:30:00 [DEBUG] replane: Connecting to SSE: host=replane.example.com, port=443, https=True
218+
2024-01-15 10:30:00 [DEBUG] replane: Connecting to SSE: host=cloud.replane.dev, port=443, https=True
219219
2024-01-15 10:30:00 [DEBUG] replane: Response status: 200 OK
220220
2024-01-15 10:30:00 [DEBUG] replane: SSE event received: type=init
221221
2024-01-15 10:30:00 [DEBUG] replane: Loaded config: rate-limit (value=100, overrides=2)

docs/source/errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ from replane import (
4949

5050
try:
5151
with Replane(
52-
base_url="https://replane.example.com",
52+
base_url="https://cloud.replane.dev",
5353
sdk_key="rp_...",
5454
) as replane:
5555
value = replane.configs["my-config"]

docs/source/frameworks.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ async def lifespan(app: FastAPI):
2323
"""Manage Replane client lifecycle."""
2424
global _replane
2525
_replane = AsyncReplane(
26-
base_url="https://replane.example.com",
26+
base_url="https://cloud.replane.dev",
2727
sdk_key="rp_...",
2828
)
2929
await _replane.connect()
@@ -111,7 +111,7 @@ def get_replane() -> Replane:
111111
global _replane
112112
if _replane is None:
113113
_replane = Replane(
114-
base_url="https://replane.example.com",
114+
base_url="https://cloud.replane.dev",
115115
sdk_key="rp_...",
116116
)
117117
_replane.connect()
@@ -190,7 +190,7 @@ replane = FlaskReplane()
190190

191191
def create_app():
192192
app = Flask(__name__)
193-
app.config["REPLANE_URL"] = "https://replane.example.com"
193+
app.config["REPLANE_URL"] = "https://cloud.replane.dev"
194194
app.config["REPLANE_SDK_KEY"] = "rp_..."
195195
replane.init_app(app)
196196
return app
@@ -208,7 +208,7 @@ Django can use either the sync or async client depending on your setup.
208208

209209
```python
210210
# settings.py
211-
REPLANE_URL = "https://replane.example.com"
211+
REPLANE_URL = "https://cloud.replane.dev"
212212
REPLANE_SDK_KEY = "rp_..."
213213

214214
# replane_client.py
@@ -305,7 +305,7 @@ _replane: AsyncReplane | None = None
305305
async def startup():
306306
global _replane
307307
_replane = AsyncReplane(
308-
base_url="https://replane.example.com",
308+
base_url="https://cloud.replane.dev",
309309
sdk_key="rp_...",
310310
)
311311
await _replane.connect()
@@ -336,7 +336,7 @@ async def create_app():
336336

337337
async def on_startup(app):
338338
app["replane"] = AsyncReplane(
339-
base_url="https://replane.example.com",
339+
base_url="https://cloud.replane.dev",
340340
sdk_key="rp_...",
341341
)
342342
await app["replane"].connect()

docs/source/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ from replane import Replane
2020

2121
# Using context manager (recommended)
2222
with Replane(
23-
base_url="https://replane.example.com",
23+
base_url="https://cloud.replane.dev",
2424
sdk_key="rp_...",
2525
) as replane:
2626
# Get a config value
@@ -49,7 +49,7 @@ from replane import AsyncReplane
4949

5050
# Using async context manager (recommended)
5151
async with AsyncReplane(
52-
base_url="https://replane.example.com",
52+
base_url="https://cloud.replane.dev",
5353
sdk_key="rp_...",
5454
) as replane:
5555
rate_limit = replane.configs["rate-limit"]
@@ -97,7 +97,7 @@ from replane import Replane
9797
from replane_types import Configs
9898

9999
with Replane[Configs](
100-
base_url="https://replane.example.com",
100+
base_url="https://cloud.replane.dev",
101101
sdk_key="rp_...",
102102
) as replane:
103103
# Dictionary-style access with full type safety

docs/source/quickstart.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ from replane import Replane
1919

2020
# Using context manager (recommended)
2121
with Replane(
22-
base_url="https://replane.example.com",
22+
base_url="https://cloud.replane.dev",
2323
sdk_key="rp_...",
2424
) as replane:
2525
# Get a simple config value
@@ -45,7 +45,7 @@ from replane import AsyncReplane
4545

4646
async def main():
4747
async with AsyncReplane(
48-
base_url="https://replane.example.com",
48+
base_url="https://cloud.replane.dev",
4949
sdk_key="rp_...",
5050
) as replane:
5151
# configs access is sync - it reads from local cache
@@ -73,15 +73,15 @@ from replane import Replane
7373

7474
# Option 1: Provide credentials in constructor
7575
replane = Replane(
76-
base_url="https://replane.example.com",
76+
base_url="https://cloud.replane.dev",
7777
sdk_key="rp_...",
7878
)
7979
replane.connect()
8080

8181
# Option 2: Provide credentials in connect()
8282
replane = Replane()
8383
replane.connect(
84-
base_url="https://replane.example.com",
84+
base_url="https://cloud.replane.dev",
8585
sdk_key="rp_...",
8686
)
8787

@@ -173,7 +173,7 @@ from replane import (
173173

174174
try:
175175
with Replane(
176-
base_url="https://replane.example.com",
176+
base_url="https://cloud.replane.dev",
177177
sdk_key="rp_...",
178178
) as replane:
179179
value = replane.configs["my-config"]

replane/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
>>> from replane import Replane
88
>>>
99
>>> with Replane(
10-
... base_url="https://replane.example.com",
10+
... base_url="https://cloud.replane.dev",
1111
... sdk_key="rp_...",
1212
... ) as replane:
1313
... if replane.configs["new-feature-enabled"]:
@@ -17,7 +17,7 @@
1717
>>> from replane import AsyncReplane
1818
>>>
1919
>>> async with AsyncReplane(
20-
... base_url="https://replane.example.com",
20+
... base_url="https://cloud.replane.dev",
2121
... sdk_key="rp_...",
2222
... ) as replane:
2323
... user_client = replane.with_context({"plan": user.plan})
@@ -28,7 +28,7 @@
2828
>>> from replane_types import Configs
2929
>>>
3030
>>> with Replane[Configs](
31-
... base_url="https://replane.example.com",
31+
... base_url="https://cloud.replane.dev",
3232
... sdk_key="rp_...",
3333
... ) as replane:
3434
... config = replane.configs["my-feature"] # fully typed dict access

replane/_async.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ class AsyncReplane(Generic[ConfigsT]):
289289
290290
Example with context manager (recommended):
291291
>>> async with AsyncReplane(
292-
... base_url="https://replane.example.com",
292+
... base_url="https://cloud.replane.dev",
293293
... sdk_key="rp_...",
294294
... ) as replane:
295295
... value = replane.configs["feature-flag"]

replane/_sync.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ class Replane(Generic[ConfigsT]):
291291
292292
Example with context manager (recommended):
293293
>>> with Replane(
294-
... base_url="https://replane.example.com",
294+
... base_url="https://cloud.replane.dev",
295295
... sdk_key="rp_...",
296296
... ) as replane:
297297
... value = replane.configs["feature-flag"]

0 commit comments

Comments
 (0)