pbirs-client

A typed Python client for the Power BI Report Server REST API, with NTLM authentication and resource-based API helpers.

Requirements

• Python 3.14 or later
• A Power BI Report Server account

Installation

uv add pbirs-client

Usage

Set the connection details:

export BI_URL="https://reports.example.com"
export BI_USERNAME="DOMAIN\\username"
export BI_PASSWORD="password"

Create a client and call an API resource:

from pbirs_client import BIClient

with BIClient.from_env() as client:
    items = client.catalog.get_catalog_items()
    print(items)

Pass documented query options through params:

with BIClient.from_env() as client:
    reports = client.power_bi_reports.get_power_bi_reports(
        params={"$select": "Id,Name,Path"},
    )

Write operations are disabled by default. Enable them explicitly when needed:

client = BIClient.from_env(allow_mutation=True)

Development

Install the development dependencies and run the offline checks:

uv sync --group dev
just all

The test report measures Python statement coverage. To separately verify API endpoint coverage against the current Microsoft Learn catalog, run the network-dependent audit:

just api-coverage

To smoke-test non-mutating API calls against a server configured in .env, run:

just smoke

The recipe uses the connection settings from .env, even when BI environment variables are already exported. The script reports response sizes without printing response data or credentials.

Documentation

• Power BI Report Server REST API