You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
SK-2707: drop .env.example from samples, document placeholder workflow
Remove samples/.env.example and the dotenv/.env loading guidance from
samples/README.md. The samples are run by replacing the inline
<PLACEHOLDER> values directly. Update the OB-11 backlog entry to match.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@@ -164,14 +164,14 @@ Evidence tagging: claims verified against code carry a `file:line` reference. It
164
164
165
165
**Acceptance criteria:** Both functions documented with a usage snippet.
166
166
167
-
### OB-11 · `samples/README.md` + `.env.example`
167
+
### OB-11 · `samples/README.md`
168
168
*Priority P1 · Effort M · Samples · Onboarding*
169
169
170
-
**Problem:** 22 sample files across `samples/{vault_api,detect_api,service_account}` have no README and no env template; each hardcodes `<PLACEHOLDERS>`. There's no `cp .env.example .env` flow to make them runnable.
170
+
**Problem:** 22 sample files across `samples/{vault_api,detect_api,service_account}` have no README explaining prerequisites or how to run them; each hardcodes `<PLACEHOLDERS>`.
171
171
172
-
**Proposed fix:** Add `samples/README.md` (prerequisites, how to run, what each sample shows) and a `.env.example` with the variables the samples read. Optionally refactor samples to load from env.
172
+
**Proposed fix:** Add `samples/README.md` (prerequisites, how to run, what each sample shows, per-sample index).
173
173
174
-
**Acceptance criteria:** A user can run any sample by copying `.env.example`, filling values, and following `samples/README.md`.
174
+
**Acceptance criteria:** A user can run any sample by following `samples/README.md` and replacing the inline placeholders with their own values.
Copy file name to clipboardExpand all lines: samples/README.md
+3-21Lines changed: 3 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,31 +7,13 @@ Runnable examples for the Skyflow Python SDK, grouped by area. Start with the [R
7
7
- Python 3.9 or above
8
8
- The SDK installed: `pip install skyflow`
9
9
- A Skyflow account, a vault, and a service account (see [Before you begin](../README.md#before-you-begin))
10
-
-The values listed in [`.env.example`](.env.example):`vault_id`, `cluster_id`, `env`, and one credential (API key, bearer token, or service-account credentials)
10
+
-Your`vault_id`, `cluster_id`, `env`, and one credential (API key, bearer token, or service-account credentials)
11
11
12
12
## Configure
13
13
14
-
Copy the env template and fill in your values:
14
+
The samples ship with inline `<PLACEHOLDER>` strings (for example `<YOUR_VAULT_ID>`). Replace the placeholders in the sample you want to run with your own values before running it.
15
15
16
-
```bash
17
-
cp .env.example .env
18
-
```
19
-
20
-
The samples ship with inline `<PLACEHOLDER>` strings (for example `<YOUR_VAULT_ID>`). You can either:
21
-
22
-
1.**Replace the placeholders** directly in the sample file you want to run, or
23
-
2.**Load from `.env`** by adding the following near the top of the sample (`python-dotenv` is already a SDK dependency):
24
-
25
-
```python
26
-
import os
27
-
from dotenv import load_dotenv
28
-
29
-
load_dotenv()
30
-
vault_id = os.getenv('SKYFLOW_VAULT_ID')
31
-
# ...use os.getenv(...) for the other values
32
-
```
33
-
34
-
> Never commit a filled-in `.env` or any real credentials.
0 commit comments