Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize examples #507

Merged
merged 4 commits into from
Dec 22, 2024
Merged

Reorganize examples #507

merged 4 commits into from
Dec 22, 2024

Conversation

dmontagu
Copy link
Contributor

I'm not sure if there's a reason we didn't use the same structure for the examples folder that we use for pydantic_ai_slim, but there was some confusion on slack and issues with it not being treated as a package, in particular, some of the commands to run things didn't work unless you removed the pydantic_ai_examples from the start of the module name references.

If this change works, I think it's fine. If there's a reason it's problematic, we can close this PR, but probably a good idea to try to resolve the original issue. See this thread for more details: https://pydanticlogfire.slack.com/archives/C083V7PMHHA/p1734643821267229

@dmontagu
Copy link
Contributor Author

(I won't be surprised if I need to update some docs references or something, either way I wanted to open this PR as a reminder to look into this all more carefully.)

@sydney-runkle
Copy link
Member

Seems reasonable but looks like we've got a docs failure?

Copy link
Member

@samuelcolvin samuelcolvin left a comment

Choose a reason for hiding this comment

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

The reason I did it this way was so the examples were not nested two directories down. I'm fine to change it, but let's rename the top level directory to examples.

Copy link

cloudflare-workers-and-pages bot commented Dec 22, 2024

Deploying pydantic-ai with  Cloudflare Pages  Cloudflare Pages

Latest commit: 539f965
Status: ✅  Deploy successful!
Preview URL: https://9af6dc4b.pydantic-ai.pages.dev
Branch Preview URL: https://dmontagu-reorganize-examples.pydantic-ai.pages.dev

View logs

@samuelcolvin samuelcolvin force-pushed the dmontagu/reorganize-examples branch from f764803 to a4fc5d8 Compare December 22, 2024 16:55
@samuelcolvin samuelcolvin merged commit b77cc97 into main Dec 22, 2024
16 checks passed
@samuelcolvin samuelcolvin deleted the dmontagu/reorganize-examples branch December 22, 2024 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants