diff --git a/Makefile b/Makefile index 86e0a9148d..ff20f8e9a7 100644 --- a/Makefile +++ b/Makefile @@ -80,8 +80,9 @@ else ifeq ($(PPPR_TOKEN),) @exit 1 else @echo 'installing insiders packages...' - @uv pip install -U mkdocs-material mkdocstrings-python \ - --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ + @uv pip install -U \ + --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ \ + mkdocs-material mkdocstrings-python endif .PHONY: docs-insiders # Build the documentation using insiders packages @@ -98,10 +99,10 @@ cf-pages-build: uv python install 3.12 uv sync --python 3.12 --frozen --group docs uv pip install -U \ - --extra-index-url https://pydantic:$(PPPR_TOKEN)@pppr.pydantic.dev/simple/ \ + --extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ \ mkdocs-material mkdocstrings-python uv pip freeze - uv run --no-sync mkdocs build + uv run --no-sync mkdocs build -f mkdocs.insiders.yml .PHONY: all all: format lint typecheck testcov diff --git a/docs/examples/index.md b/docs/examples/index.md index 497f4909fe..d5dcc29ab4 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -1,6 +1,6 @@ # Examples -Examples of how to use Pydantic AI and what it can do. +Examples of how to use PydanticAI and what it can do. ## Usage diff --git a/docs/examples/pydantic-model.md b/docs/examples/pydantic-model.md index 637bce859e..184d096913 100644 --- a/docs/examples/pydantic-model.md +++ b/docs/examples/pydantic-model.md @@ -1,4 +1,6 @@ -Simple example of using Pydantic AI to construct a Pydantic model from a text input. +# Pydantic Model + +Simple example of using PydanticAI to construct a Pydantic model from a text input. Demonstrates: diff --git a/docs/examples/rag.md b/docs/examples/rag.md index 88b5b76250..9a4d5382db 100644 --- a/docs/examples/rag.md +++ b/docs/examples/rag.md @@ -9,7 +9,7 @@ Demonstrates: * RAG search This is done by creating a database containing each section of the markdown documentation, then registering -the search tool as a retriever with the Pydantic AI agent. +the search tool as a retriever with the PydanticAI agent. Logic for extracting sections from markdown files and a JSON file with that data is available in [this gist](https://gist.github.com/samuelcolvin/4b5bb9bb163b1122ff17e29e48c10992). @@ -34,7 +34,7 @@ With that running and [dependencies installed and environment variables set](./i python/uv-run -m pydantic_ai_examples.rag build ``` -(Note building the database doesn't use Pydantic AI right now, instead it uses the OpenAI SDK directly.) +(Note building the database doesn't use PydanticAI right now, instead it uses the OpenAI SDK directly.) You can then ask the agent a question with: diff --git a/docs/examples/sql-gen.md b/docs/examples/sql-gen.md index da9ee2e05b..0de1cead29 100644 --- a/docs/examples/sql-gen.md +++ b/docs/examples/sql-gen.md @@ -1,6 +1,6 @@ # SQL Generation -Example demonstrating how to use Pydantic AI to generate SQL queries based on user input. +Example demonstrating how to use PydanticAI to generate SQL queries based on user input. Demonstrates: diff --git a/docs/examples/weather-agent.md b/docs/examples/weather-agent.md index 1652935ab1..f5112a0307 100644 --- a/docs/examples/weather-agent.md +++ b/docs/examples/weather-agent.md @@ -1,4 +1,4 @@ -Example of Pydantic AI with multiple tools which the LLM needs to call in turn to answer a question. +Example of PydanticAI with multiple tools which the LLM needs to call in turn to answer a question. Demonstrates: diff --git a/pydantic_ai_examples/README.md b/pydantic_ai_examples/README.md index 62289d7528..d1ea997ff9 100644 --- a/pydantic_ai_examples/README.md +++ b/pydantic_ai_examples/README.md @@ -1,5 +1,5 @@ -# Pydantic AI Examples +# PydanticAI Examples -Examples of how to use Pydantic AI and what it can do. +Examples of how to use PydanticAI and what it can do. Full documentation of these examples and how to run them is available at [ai.pydantic.dev/examples/](https://ai.pydantic.dev/examples/). diff --git a/pydantic_ai_examples/pydantic_model.py b/pydantic_ai_examples/pydantic_model.py index 54f53df2bf..9c654e9e1a 100644 --- a/pydantic_ai_examples/pydantic_model.py +++ b/pydantic_ai_examples/pydantic_model.py @@ -1,4 +1,4 @@ -"""Simple example of using Pydantic AI to construct a Pydantic model from a text input. +"""Simple example of using PydanticAI to construct a Pydantic model from a text input. Run with: diff --git a/pydantic_ai_examples/pyproject.toml b/pydantic_ai_examples/pyproject.toml index b0e296dd33..9ef9c63578 100644 --- a/pydantic_ai_examples/pyproject.toml +++ b/pydantic_ai_examples/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "hatchling.build" [project] name = "pydantic-ai-examples" version = "0.0.6" -description = "Agent Framework / shim to use Pydantic with LLMs" +description = "Examples of how to use PydanticAI and what it can do." authors = [ { name = "Samuel Colvin", email = "samuel@pydantic.dev" }, ] diff --git a/pydantic_ai_examples/roulette_wheel.py b/pydantic_ai_examples/roulette_wheel.py index c9195ee3f9..21820305e0 100644 --- a/pydantic_ai_examples/roulette_wheel.py +++ b/pydantic_ai_examples/roulette_wheel.py @@ -1,4 +1,4 @@ -"""Example demonstrating how to use Pydantic AI to create a simple roulette game. +"""Example demonstrating how to use PydanticAI to create a simple roulette game. Run with: uv run -m pydantic_ai_examples.roulette_wheel diff --git a/pydantic_ai_examples/sql_gen.py b/pydantic_ai_examples/sql_gen.py index f5c4e28aa5..843ebc138e 100644 --- a/pydantic_ai_examples/sql_gen.py +++ b/pydantic_ai_examples/sql_gen.py @@ -1,4 +1,4 @@ -"""Example demonstrating how to use Pydantic AI to generate SQL queries based on user input. +"""Example demonstrating how to use PydanticAI to generate SQL queries based on user input. Run postgres with: diff --git a/pydantic_ai_examples/weather_agent.py b/pydantic_ai_examples/weather_agent.py index fd70d34c16..6e69920dc2 100644 --- a/pydantic_ai_examples/weather_agent.py +++ b/pydantic_ai_examples/weather_agent.py @@ -1,4 +1,4 @@ -"""Example of Pydantic AI with multiple tools which the LLM needs to call in turn to answer a question. +"""Example of PydanticAI with multiple tools which the LLM needs to call in turn to answer a question. In this case the idea is a "weather" agent — the user can ask for the weather in multiple cities, the agent will use the `get_lat_lng` tool to get the latitude and longitude of the locations, then use diff --git a/pydantic_ai_slim/pyproject.toml b/pydantic_ai_slim/pyproject.toml index ebd7f3362f..257f497f00 100644 --- a/pydantic_ai_slim/pyproject.toml +++ b/pydantic_ai_slim/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "hatchling.build" [project] name = "pydantic-ai-slim" version = "0.0.6" -description = "Agent Framework / shim to use Pydantic with LLMs" +description = "Agent Framework / shim to use Pydantic with LLMs, slim package" authors = [ { name = "Samuel Colvin", email = "samuel@pydantic.dev" }, ]