Skip to content

Installation

pytest-nijam is the Nijam reporter for pytest. It’s a pytest plugin - installing it is enough for pytest to auto-load it via the pytest11 entry point, so there’s no code to add. It’s open source, fail-soft (it never breaks your test run), has zero runtime dependencies, and requires Python >= 3.8.

Terminal window
pip install pytest-nijam

Configure it in pytest.ini under the [pytest] section (or in [tool.pytest.ini_options] in pyproject.toml), and set the API key as an environment variable:

pytest.ini
[pytest]
nijam_project_id = <your-project-uuid>
Terminal window
export NIJAM_API_KEY=...

If you keep config in pyproject.toml instead:

pyproject.toml
[tool.pytest.ini_options]
nijam_project_id = "<your-project-uuid>"

The two required values are the API key (NIJAM_API_KEY) and nijam_project_id - see Configuration for the full list and where to find them.

Run your suite with pytest. If Nijam is reachable and the credentials are valid, the run shows up in your project in the dashboard. If something’s off (bad key, wrong project, network), the plugin prints a [nijam] warning and your tests still pass/fail exactly as before.

Next: Configuration →