Skip to content

Verification and Packaging

Run these checks to validate the runtime and build local package artifacts.

Local Checks

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

If python-rag-framework is accessible locally or through Git credentials, also run:

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

Review:

  • README.md
  • docs/
  • CHANGELOG.md
  • pyproject.toml
  • examples in examples/

Runtime Capabilities

The runtime provides:

  • Lightweight Agent and Runtime.
  • Prompt building, history and optional memory.
  • Tool registration and execution.
  • Callback lifecycle events.
  • Streaming support.
  • Optional python-rag-framework retrieval integration.
  • Callable and OpenAI LLM adapters.
  • Examples, documentation, CI and package metadata.

Private RAG Dependency

python-rag-framework is a private portfolio dependency. The main CI workflow does not install the rag extra, so it can pass without access to that private repository. The RAG integration test is still present and is skipped when the package is unavailable.

To verify the integration in GitHub Actions, configure a repository secret named RAG_FRAMEWORK_TOKEN. Use a fine-grained GitHub token with read-only Contents access to the private python-rag-framework repository, then run the manual RAG Integration workflow.

Package Artifacts

Build artifacts locally:

uv build

Build artifacts only after the checks pass and the changelog reflects the changes.

Documentation Site

The documentation site is deployed with the manual or push-triggered Pages workflow. Configure GitHub Pages with Source: GitHub Actions, then use:

https://lelouchzr.github.io/python-agent-runtime/