Getting Started

Installation

  • We currently support Python versions 3.10, 3.11, 3.12, and 3.13.

  • The Flakefighters plugin can be installed through the Python Package Index (PyPI) (recommended for normal use), or directly from source (recommended for contributors).

Method 1: Installing via pip

To install the extension using pip for the latest stable version:

pip install pytest-flakefighters

The plugin will then automatically run as part of pytest.

If you also want to install the framework with (optional) development packages/tools:

pip install pytest-flakefighters[dev]

Note

If you plan to use the extension using a PostgreSQL database (see Remote Databases), then you will need to install PostgreSQL on your system, have pg_config on your path, and then install using the pg option.

pip install pytest-flakefighters[pg]

If you wish to use other dialects, you may need to install additional packages to support this.

Method 2: Installing via Source (For Developers/Contributors)

If you’re planning to contribute to the project or need an editable installation for development, you can install directly from source:

git clone https://github.com/test-flare/pytest-flakefighters.git
cd pytest-flakefighters

then, to install a specific release:

git fetch --all --tags --prune
git checkout tags/<tag> -b <branch>
pip install . # For core API only
pip install -e . # For editable install, useful for development work

e.g. version 1.0.0:

git fetch --all --tags --prune
git checkout tags/1.0.0 -b version
pip install .

or to install the latest development version:

pip install .

To also install developer tools:

pip install -e .[dev]

Verifying Your Installation

After installation, verify that the framework is installed correctly in your environment:

python -c "import pytest_flakefighters; print(pytest_flakefighters.__version__)"

Next Steps

  • Check out the Configuration to learn how to configure the extension.