inspect-jitsi

Tools for inspecting a running Jitsi Meet deployment.

• Changelog
• PyPI
• Source

Installation

Install the inspect-jitsi command with pipx:

pipx install inspect-jitsi[cli]

Install as a Python module only:

pip install inspect-jitsi

Command Line API

The command line requires installing inspect-jitsi[cli].

First, join or leave the room at meet.hosted.quelltext.eu/inspect-jitsi. Then run the commands:

inspect-jitsi count https://meet.hosted.quelltext.eu/inspect-jitsi
inspect-jitsi participants https://meet.hosted.quelltext.eu/inspect-jitsi
inspect-jitsi diagnose https://meet.hosted.quelltext.eu/inspect-jitsi
inspect-jitsi created https://meet.hosted.quelltext.eu/inspect-jitsi

count/participants fall back to running diagnose and printing its report to stderr if they fail, to help explain why (e.g. a token being required).

Python API (Sync)

from inspect_jitsi import (
    get_participant_count,
    get_participants,
    diagnose_jitsi_access,
    is_room_created,
)

get_participant_count("https://meet.example.com/SomeRoomName")   # -> 2
get_participants("https://meet.example.com/SomeRoomName")        # -> [Participant(...), ...]
diagnose_jitsi_access("https://meet.example.com/SomeRoomName")   # -> DiagnosisResult(...)
is_room_created("https://meet.example.com/SomeRoomName")         # -> True

Participant and DiagnosisResult are dataclasses with .to_dict() (and Participant also has .to_json()) for easy serialization. Participant carries jid, nick, name (display name, if disclosed), role, affiliation, real_jid, and occupant_id.

Python API (Async)

For anything beyond a single one-shot call - e.g. holding a room open and polling it repeatedly - use JitsiConference directly instead of the sync wrappers above; it's fully async/await:

import asyncio
from inspect_jitsi import JitsiConference

async def main():
    async with JitsiConference("https://meet.example.com/SomeRoomName") as conference:
        print(await conference.is_created())      # -> True, without joining
        print(await conference.get_participants())

asyncio.run(main())

How it works

Installing

pip install -e .          # Python API only
pip install -e ".[cli]"   # + the inspect-jitsi command line tool
pip install -e ".[test]"  # + test dependencies

Testing

pytest

Release

1. Edit the changelog
2. Create a tag and push it.

git tag v0.0.1
git push origin v0.0.1