Skip to content

✍️ Scribe: Fix broken quickstart onboarding path#772

Draft
fderuiter wants to merge 1 commit intomainfrom
scribe/quickstart-load-dotenv-7375829949248800299
Draft

✍️ Scribe: Fix broken quickstart onboarding path#772
fderuiter wants to merge 1 commit intomainfrom
scribe/quickstart-load-dotenv-7375829949248800299

Conversation

@fderuiter
Copy link
Copy Markdown
Owner

✍️ Scribe: Fix broken quickstart onboarding path

💡 What: Added load_dotenv() from python-dotenv to the quick start examples (examples/quick_start.py and examples/async_quick_start.py) and updated the README.md to reflect this code addition. Removed the confusing caveat that warned users they had to add this themselves.

🎯 Why: The previous README.md instructed users to copy .env.example to .env to authenticate, but running the examples failed with a misleading "API key required" error because the code didn't actually parse the .env file. This is a common and immediate blocker for new users.

🧠 Cognitive Impact: Fixes a first-run crash. A new developer can now copy .env.example, fill it out, and immediately run poetry run python examples/quick_start.py successfully. This matches the behavior of the CLI and eliminates a frustrating "why isn't my config working?" moment.

📖 Preview:

from dotenv import load_dotenv

# Load environment variables from .env file if it exists
load_dotenv()

# Load credentials from environment variables
cfg = load_config()

PR created automatically by Jules for task 7375829949248800299 started by @fderuiter

💡 What: Added `load_dotenv()` from `python-dotenv` to the quick start examples (`examples/quick_start.py` and `examples/async_quick_start.py`) and updated the `README.md` to reflect this code addition. Removed the confusing caveat that warned users they had to add this themselves.

🎯 Why: The previous `README.md` instructed users to copy `.env.example` to `.env` to authenticate, but running the examples failed with a misleading "API key required" error because the code didn't actually parse the `.env` file. This is a common and immediate blocker for new users.

🧠 Cognitive Impact: Fixes a first-run crash. A new developer can now copy `.env.example`, fill it out, and immediately run `poetry run python examples/quick_start.py` successfully. This matches the behavior of the CLI and eliminates a frustrating "why isn't my config working?" moment.

📖 Preview:
```python
from dotenv import load_dotenv

# Load environment variables from .env file if it exists
load_dotenv()

# Load credentials from environment variables
cfg = load_config()
```

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant