Skip to content

docs: add per-example READMEs with .env support#25

Merged
tracisiebel merged 8 commits intomainfrom
devin/1777327685-example-readmes
Apr 28, 2026
Merged

docs: add per-example READMEs with .env support#25
tracisiebel merged 8 commits intomainfrom
devin/1777327685-example-readmes

Conversation

@tracisiebel
Copy link
Copy Markdown
Contributor

@tracisiebel tracisiebel commented Apr 27, 2026

Summary

Restructures the repository so each example is self-contained in its own directory with a dedicated README, pyproject.toml, and source files. Adds .env file support via python-dotenv.

Review & Testing Checklist for Human

  • cd into an example directory (e.g. examples/openai) and run poetry install && poetry run openai-example to confirm the self-contained setup works
  • Verify each example README has correct env vars, install, and run commands
  • Confirm main README table links resolve to the correct example READMEs

Notes

  • Root pyproject.toml deleted; CI updated to loop through each example directory with poetry -C "$dir" install
  • Bedrock example now reads AWS_DEFAULT_REGION from env with us-east-1 fallback
  • .env added to .gitignore

Link to Devin session: https://app.devin.ai/sessions/26e40d921a3d4e42a01faa3068908c23
Requested by: @tracisiebel

- Create individual README files for each example (openai, bedrock, gemini,
  langchain, langgraph-agent, langgraph-multi-agent, judge, chat-observability)
- Add python-dotenv dependency and load_dotenv() to all examples
- Add .env to .gitignore
- Update main README to link to example READMEs via table

Co-Authored-By: traci@launchdarkly.com <traci@launchdarkly.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@devin-ai-integration devin-ai-integration Bot added the devin-pr PR created by Devin label Apr 27, 2026
@tracisiebel tracisiebel marked this pull request as ready for review April 27, 2026 23:32
@tracisiebel tracisiebel requested a review from a team as a code owner April 27, 2026 23:32
Copy link
Copy Markdown
Contributor

@jsonbailey jsonbailey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move the examples into the folders along with the readmes?

@devin-ai-integration
Copy link
Copy Markdown
Contributor

On it — I'll move the example files into their respective directories and update the pyproject.toml script paths accordingly.

@tracisiebel
Copy link
Copy Markdown
Contributor Author

are you still working devin?

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Yes! My VM had a connectivity issue but it's back. Working on moving the example files into their folders now.

tracisiebel and others added 2 commits April 28, 2026 09:52
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Rename langgraph-agent, langgraph-multi-agent, chat-observability to
  use underscores so they are valid Python packages
- Add __init__.py to each example subfolder
- Update pyproject.toml script paths to reflect new module locations

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@tracisiebel tracisiebel requested a review from jsonbailey April 28, 2026 16:59
- Add per-example pyproject.toml with only the dependencies that
  example needs; no extras flags required, just `poetry install`
- Remove __init__.py files (no longer needed as Python packages)
- Simplify root pyproject.toml, removing scripts/extras/packages
- Update READMEs to reflect local .env and plain `poetry install`

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread examples/bedrock/bedrock_example.py Outdated
Comment thread pyproject.toml Outdated
Comment thread examples/judge/pyproject.toml
Comment thread examples/openai/pyproject.toml Outdated
- Fix README table links to use underscores matching actual directory names
- Add comment to root pyproject.toml directing users to example subdirectories
- Add missing langchain and openai deps to judge pyproject.toml
- Read AWS_DEFAULT_REGION from env in bedrock example instead of hardcoding
- Fix openai version constraint from >=0.2.0 to >=1.0.0

Co-Authored-By: traci@launchdarkly.com <traci@launchdarkly.com>
devin-ai-integration Bot and others added 3 commits April 28, 2026 18:51
Co-Authored-By: traci@launchdarkly.com <traci@launchdarkly.com>
Co-Authored-By: traci@launchdarkly.com <traci@launchdarkly.com>
Co-Authored-By: traci@launchdarkly.com <traci@launchdarkly.com>
@tracisiebel tracisiebel merged commit 916a13e into main Apr 28, 2026
4 checks passed
@tracisiebel tracisiebel deleted the devin/1777327685-example-readmes branch April 28, 2026 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devin-pr PR created by Devin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants