Skip to content

πŸ–‹οΈ Scribe: Fix execution commands and bash syntax in examples#762

Merged
fderuiter merged 2 commits intomainfrom
fix-example-commands-6940982492059089691
Apr 2, 2026
Merged

πŸ–‹οΈ Scribe: Fix execution commands and bash syntax in examples#762
fderuiter merged 2 commits intomainfrom
fix-example-commands-6940982492059089691

Conversation

@fderuiter
Copy link
Copy Markdown
Owner

πŸ’‘ What:

  • Updated bash commands in docstrings (e.g., examples/quick_start.py) and .rst files to use poetry run python examples/... instead of python examples/....
  • Changed export IMEDNET_BASE_URL (optional) to # export IMEDNET_BASE_URL in RST examples.

🎯 Why:

  • ModuleNotFoundError: If developers run python examples/quick_start.py from source before fully installing the package globally, it errors out because src/ isn't in sys.path. Using poetry run python guarantees it runs inside the project's virtual environment.
  • Bash syntax error: Users who copy-paste export VAR_NAME (optional) into a terminal receive a syntax error bash: syntax error near unexpected token '('.

🧠 Cognitive Impact:

  • Fixes first-run crash for developers cloning the project.
  • Prevents copy-paste errors, creating a smoother onboarding path.

πŸ“– Preview:

   export IMEDNET_API_KEY
   export IMEDNET_SECURITY_KEY
   export IMEDNET_STUDY_KEY
   # export IMEDNET_BASE_URL
    # Usage:
    poetry run python examples/quick_start.py

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

* Updated docstrings and .rst files to use `poetry run python examples/...`
  instead of `python examples/...` to fix ModuleNotFoundError when running
  from source.
* Updated optional export environment variables to use `# export` so that
  they can be copied safely without throwing bash syntax errors.

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.

* Updated docstrings and .rst files to use `poetry run python examples/...`
  instead of `python examples/...` to fix ModuleNotFoundError when running
  from source.
* Updated optional export environment variables to use `# export` so that
  they can be copied safely without throwing bash syntax errors.
* Formatted build_form_payload.py command help to pass line length checks.
* Removed orphaned docs/imednet.cli.intervals.rst file that caused sphinx
  build failures.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
@fderuiter fderuiter marked this pull request as ready for review April 2, 2026 21:36
@fderuiter fderuiter merged commit 8e21b32 into main Apr 2, 2026
13 checks passed
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