From ef8a0b7eb6146ce98af711b437d390740fa0727f Mon Sep 17 00:00:00 2001
From: fderuiter <127706008+fderuiter@users.noreply.github.com>
Date: Wed, 13 May 2026 21:11:33 +0000
Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8D=EF=B8=8F=20Scribe:=20Missing?=
 =?UTF-8?q?=20dotenv=20fallbacks=20in=20examples?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Added full fallback shell export instructions for environment variables (including `IMEDNET_BASE_URL`) across quickstart documentation and example scripts.

`dotenv.load_dotenv()` silently fails when `.env` is missing, which causes broken onboarding paths and missing variable errors for new users if alternative export instructions are incomplete.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
---
 docs/async_quick_start.rst     | 2 ++
 docs/quick_start.rst           | 2 ++
 examples/async_quick_start.py  | 2 ++
 examples/build_form_payload.py | 4 ++++
 examples/quick_start.py        | 2 ++
 5 files changed, 12 insertions(+)

diff --git a/docs/async_quick_start.rst b/docs/async_quick_start.rst
index 646562d4..6741649d 100644
--- a/docs/async_quick_start.rst
+++ b/docs/async_quick_start.rst
@@ -31,6 +31,8 @@ Set your credentials by copying the environment template or exporting them direc
    # Option 2: Export directly to your shell
    export IMEDNET_API_KEY="your_api_key"
    export IMEDNET_SECURITY_KEY="your_security_key"
+   # Optional: Custom base URL for the API endpoint
+   # export IMEDNET_BASE_URL="https://edc.prod.imednetapi.com"
 
 List studies asynchronously and poll a job:
 
diff --git a/docs/quick_start.rst b/docs/quick_start.rst
index 525a6b6a..6d5ee9d3 100644
--- a/docs/quick_start.rst
+++ b/docs/quick_start.rst
@@ -26,6 +26,8 @@ Set your credentials by copying the environment template or exporting them direc
    # Option 2: Export directly to your shell
    export IMEDNET_API_KEY="your_api_key"
    export IMEDNET_SECURITY_KEY="your_security_key"
+   # Optional: Custom base URL for the API endpoint
+   # export IMEDNET_BASE_URL="https://edc.prod.imednetapi.com"
 
 Enable structured logging and list studies:
 
diff --git a/examples/async_quick_start.py b/examples/async_quick_start.py
index df777726..61d80e8b 100644
--- a/examples/async_quick_start.py
+++ b/examples/async_quick_start.py
@@ -21,6 +21,8 @@
     # Or export directly:
     export IMEDNET_API_KEY="your_api_key"
     export IMEDNET_SECURITY_KEY="your_security_key"
+    # Optional: Custom base URL for the API endpoint
+    # export IMEDNET_BASE_URL="https://edc.prod.imednetapi.com"
     poetry run python examples/async_quick_start.py
 """
 
diff --git a/examples/build_form_payload.py b/examples/build_form_payload.py
index b4462765..ece66ae0 100644
--- a/examples/build_form_payload.py
+++ b/examples/build_form_payload.py
@@ -4,6 +4,10 @@
 
 Usage:
   cp .env.example .env
+  # Or export directly:
+  # export IMEDNET_API_KEY="your_api_key"
+  # export IMEDNET_SECURITY_KEY="your_security_key"
+  # export IMEDNET_BASE_URL="https://edc.prod.imednetapi.com"
 
   # Headless Mode (CLI)
   poetry run python examples/build_form_payload.py \
diff --git a/examples/quick_start.py b/examples/quick_start.py
index c65269c2..578b0f99 100644
--- a/examples/quick_start.py
+++ b/examples/quick_start.py
@@ -18,6 +18,8 @@
     # Or export directly:
     export IMEDNET_API_KEY="your_api_key"
     export IMEDNET_SECURITY_KEY="your_security_key"
+    # Optional: Custom base URL for the API endpoint
+    # export IMEDNET_BASE_URL="https://edc.prod.imednetapi.com"
     poetry run python examples/quick_start.py
 """