Skip to content

Install

osr-forge requires Python ≥ 3.14. Install from PyPI with uv or pip:

uv pip install osr-forge
# or
pip install osr-forge

The package name is osr-forge; the import is osrforge, and the console script is osrforge.

The entra extra

The Azure AI Foundry adapter authenticates with an API key by default. To use Entra ID (DefaultAzureCredential) instead, install the extra:

uv pip install 'osr-forge[entra]'

See provider setup for the environment variables.

What comes with it

  • The osrforge CLI: convert, rerun, assemble, check, preview, and estimate — see the CLI reference.
  • The library API: convert, assemble, check, estimate, and ConversionSettings, re-exported from the osrforge package root.
  • osrlib itself, as a dependency — converted output validates against the real models, never a copy.

osr-forge ships no game content: osrlib's SRD data stays in osrlib, and your module PDFs never leave your machine except as requests to the model provider you configure.