Install PyRIT Library

Install PyRIT Library#

Choose Your Installation Method#

PyRIT offers two installation options for users:

Option 1: Docker (Recommended for Quick Start)#

If you want to get started quickly without setting up a Python environment, use our pre-configured Docker container. See the Docker Installation Guide for complete instructions for running PyRIT in Docker with JupyterLab

Pre-installed PyRIT with all dependencies
No Python environment setup required
Works on Windows, macOS, and Linux

Use Docker if you:

Want to get started immediately
Prefer not to manage Python environments
Want a consistent, isolated environment
Plan to use JupyterLab for interactive work

Option 2: Local Installation with Pip/Conda#

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 a conda environment as follows

conda create -y -n <environment-name> python=3.11

followed by conda activate <environment-name>

Once the environment with the correct Python version is set up, run

pip install pyrit

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.

Check your installed version:
```
pip freeze | grep pyrit
```

Or in Python:

import pyrit
print(pyrit.__version__)

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).
If you installed from source: The notebooks in your cloned repository will already match your code version.