Skip to content

Commit 4dfd254

Browse files
committed
chore: docs
1 parent ada05e4 commit 4dfd254

6 files changed

Lines changed: 15 additions & 15 deletions

File tree

docs/source/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ from replane import SyncReplaneClient
1212
replane = SyncReplaneClient(
1313
# Required
1414
base_url="https://replane.example.com",
15-
sdk_key="sk_live_...",
15+
sdk_key="rp_...",
1616

1717
# Optional
1818
context={"environment": "production"},
@@ -46,8 +46,8 @@ base_url="http://localhost:3000" # Local development
4646
Your SDK key from the Replane dashboard. SDK keys are scoped to a specific project and environment.
4747

4848
```python
49-
sdk_key="sk_live_abc123..." # Production
50-
sdk_key="sk_test_xyz789..." # Testing/staging
49+
sdk_key="rp_abc123..." # Production
50+
sdk_key="rp_test_xyz789..." # Testing/staging
5151
```
5252

5353
### Optional Options

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
try:
5050
with SyncReplaneClient(
5151
base_url="https://replane.example.com",
52-
sdk_key="sk_live_...",
52+
sdk_key="rp_...",
5353
) as replane:
5454
value = replane.get("my-config")
5555
except ConfigNotFoundError as e:

docs/source/frameworks.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ async def lifespan(app: FastAPI):
2222
global _replane
2323
_replane = AsyncReplaneClient(
2424
base_url="https://replane.example.com",
25-
sdk_key="sk_live_...",
25+
sdk_key="rp_...",
2626
)
2727
await _replane.connect()
2828
yield
@@ -116,7 +116,7 @@ def get_replane() -> SyncReplaneClient:
116116
if _replane is None:
117117
_replane = SyncReplaneClient(
118118
base_url="https://replane.example.com",
119-
sdk_key="sk_live_...",
119+
sdk_key="rp_...",
120120
)
121121
_replane.connect()
122122
return _replane
@@ -195,7 +195,7 @@ replane = FlaskReplane()
195195
def create_app():
196196
app = Flask(__name__)
197197
app.config["REPLANE_URL"] = "https://replane.example.com"
198-
app.config["REPLANE_SDK_KEY"] = "sk_live_..."
198+
app.config["REPLANE_SDK_KEY"] = "rp_..."
199199
replane.init_app(app)
200200
return app
201201

@@ -213,7 +213,7 @@ Django can use either the sync or async client depending on your setup.
213213
```python
214214
# settings.py
215215
REPLANE_URL = "https://replane.example.com"
216-
REPLANE_SDK_KEY = "sk_live_..."
216+
REPLANE_SDK_KEY = "rp_..."
217217

218218
# replane_client.py
219219
from django.conf import settings
@@ -306,7 +306,7 @@ async def startup():
306306
global _replane
307307
_replane = AsyncReplaneClient(
308308
base_url="https://replane.example.com",
309-
sdk_key="sk_live_...",
309+
sdk_key="rp_...",
310310
)
311311
await _replane.connect()
312312

@@ -337,7 +337,7 @@ async def create_app():
337337
async def on_startup(app):
338338
app["replane"] = AsyncReplaneClient(
339339
base_url="https://replane.example.com",
340-
sdk_key="sk_live_...",
340+
sdk_key="rp_...",
341341
)
342342
await app["replane"].connect()
343343

docs/source/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ from replane import SyncReplaneClient
1818

1919
with SyncReplaneClient(
2020
base_url="https://replane.example.com",
21-
sdk_key="sk_live_...",
21+
sdk_key="rp_...",
2222
) as replane:
2323
# Get a config value
2424
rate_limit = replane.get("rate-limit")

docs/source/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ from replane import SyncReplaneClient
2020
# Using context manager (recommended)
2121
with SyncReplaneClient(
2222
base_url="https://replane.example.com",
23-
sdk_key="sk_live_...",
23+
sdk_key="rp_...",
2424
) as replane:
2525
# Get a simple config value
2626
rate_limit = replane.get("rate-limit")
@@ -48,7 +48,7 @@ from replane import AsyncReplaneClient
4848
async def main():
4949
async with AsyncReplaneClient(
5050
base_url="https://replane.example.com",
51-
sdk_key="sk_live_...",
51+
sdk_key="rp_...",
5252
) as replane:
5353
# get() is sync - it reads from local cache
5454
rate_limit = replane.get("rate-limit")
@@ -149,7 +149,7 @@ from replane import (
149149
try:
150150
with SyncReplaneClient(
151151
base_url="https://replane.example.com",
152-
sdk_key="sk_live_...",
152+
sdk_key="rp_...",
153153
) as replane:
154154
value = replane.get("my-config")
155155
except ConfigNotFoundError as e:

replane/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
_MINOR = "1"
33
# On main and in a nightly release the patch should be one ahead of the last
44
# released build.
5-
_PATCH = "6"
5+
_PATCH = "7"
66
# This is mainly for nightly builds which have the suffix ".dev$DATE". See
77
# https://semver.org/#is-v123-a-semantic-version for the semantics.
88
_SUFFIX = ""

0 commit comments

Comments
 (0)