Skip to content

Installation

Prerequisites

Ensure you have:

  • Python 3.8 or later installed
  • pip (latest version recommended)

Installing FauxPy

FauxPy is available on PyPI. Install it via pip:

pip install fauxpy

Or, to install the latest development version from GitHub:

pip install git+https://github.com/atom-sw/fauxpy

Running this second command installs the latest version of FauxPy available on the main branch of its GitHub repository.

Setting Up Your LLM API Key

If you are using MBFL with mutation strategies beyond the traditional approach—i.e., those leveraging LLMs—you must configure an API key. This is because FauxPy relies on PyLLMut to generate LLM-driven mutants, and PyLLMut requires an API key to access LLMs.

To set up your API key, follow the instructions in the Setting Up Your LLM API Key section of the PyLLMut installation guide.