Installation

Core Package

uv add python-agent-runtime

The core package depends only on Pydantic.

With python-rag-framework

python-rag-framework is the official retrieval backend:

uv add "python-rag-framework @ git+https://github.com/lelouchzr/python-rag-framework.git@v0.1.0"

The dependency is optional. Agents can run without retrieval.

If the repository is private, this install command requires GitHub credentials with read access to python-rag-framework. In CI, keep normal runtime checks independent from that private dependency and run RAG integration in a separate authenticated workflow.

With OpenAI

uv add "python-agent-runtime[openai]"

OpenAIChatLLM imports the OpenAI package lazily, so the rest of the runtime does not require provider dependencies.

Development

uv sync --extra dev --extra openai
uv run ruff check .
uv run mypy
uv run pytest
uv run mkdocs build --strict
uv build

For local RAG integration checks, install the private dependency too:

uv sync --extra dev --extra openai
uv pip install "python-rag-framework @ git+https://github.com/lelouchzr/python-rag-framework.git@v0.1.0"
uv run pytest tests/test_rag_integration.py