Contributor Docker Installation

DevContainers provide a pre-configured development environment for PyRIT using Docker and VS Code, ensuring consistency across all contributors.

Prerequisites¶

Before starting, install:

1. Docker (Docker Desktop if you are using Windows)

   • Download Docker

2. Visual Studio Code

   • Download VS Code

3. DevContainers Extension in VS Code

   • Install DevContainer Extension

You can also follow the Installation section on Developing inside a Container for more details.

Setup Steps¶

1. Clone the PyRIT Repository¶

git clone https://github.com/microsoft/PyRIT
cd PyRIT

2. Open in VS Code¶

Open the PyRIT folder in Visual Studio Code:

code .

3. Reopen in Container¶

Make sure Docker is running first, for example, by starting “Docker Desktop.”

Press Ctrl + Shift + P (or Cmd + Shift + P on macOS) to open the VS Code Command Palette, then type and select:

Dev Containers: Reopen in Container

VS Code will:

1. Build the development container (this may take several minutes the first time)

2. Install all dependencies

3. Configure the development environment

4. Reopen VS Code inside the container

Working with Jupyter Notebooks¶

Selecting a Kernel¶

When working with Jupyter Notebooks (.ipynb files):

1. Open a notebook file in VS Code

2. Click the “Select Kernel” button in the top-right corner of the notebook

3. Choose “Python Environments...”

4. Select the pyrit-dev kernel

Alternatively, you can use the Command Palette:

• Press Ctrl + Shift + P (or Cmd + Shift + P on macOS)

• Type >Notebook: Select Notebook Kernel

• Choose “Python Environments...” > pyrit-dev

This kernel will run all code examples in Python Notebooks.

Viewing Jupyter Variables¶

To view variables populated by code examples:

1. Go to View > Output

2. Select Jupyter from the dropdown menu

Common DevContainer Operations¶

Rebuild the Container¶

If you need to rebuild the container (e.g., after dependency changes):

1. Press Ctrl + Shift + P (or Cmd + Shift + P on macOS)

2. Type and select: Dev Containers: Rebuild Container

Reopen Locally¶

To exit the container and return to your local environment:

1. Press Ctrl + Shift + P (or Cmd + Shift + P on macOS)

2. Type and select: Dev Containers: Reopen Folder Locally

Next Step: Configure PyRIT¶

After setting up your DevContainer, configure your AI endpoint credentials.

Troubleshooting¶

Having issues? See the DevContainers Troubleshooting guide for common problems and solutions.