Install PyRIT Library

Install PyRIT Library#

Choose Your Installation Method#

PyRIT offers three installation options for users:

Option 2: Local Installation with Pip/uv#

For a traditional Python installation on your local machine, follow the instructions below.

Use local installation if you:

  • Want to integrate PyRIT into existing Python workflows

  • Prefer a lighter-weight installation

  • Need to customize your Python environment

  • Want direct access to PyRIT from your system Python

Local Installation Instructions#

To install PyRIT using pip, make sure you have Python 3.10, 3.11, 3.12, or 3.13 installed using python --version. Alternatively, create an environment from the root directory as follows

uv sync

Next, check out our docs and run the notebooks in your environment!

{important} Matching Notebooks to Your Version:

Notebooks and your PyRIT installation must be on the same version. This pip installation gives you the latest stable release from PyPI.

  1. Check your installed version:

    uv pip freeze | grep pyrit

    Or in Python:

    import pyrit
print(pyrit.__version__)

  2. Match notebooks to your version:

    • If using a release version (e.g., 0.9.0), download notebooks from the corresponding release branch: https://github.com/Azure/PyRIT/tree/releases/v0.9.0/doc

    • The automatically cloned notebooks from the main branch may not match your installed version

    • This website documentation shows the latest development version (main branch).

  3. If you installed from source: The notebooks in your cloned repository will already match your code version.

Option 3: Local Installation with Pip/Conda#

We highly recommend using Option 2, but if you would prefer to use conda, See the Conda Installation Guide for complete instructions for running PyRIT in a conda environment

Contents