Skip to main content

Installation

aiosignalr is distributed on PyPI. Install it with your favourite Python package manager.

pip​

pip install aiosignalr

uv​

uv add aiosignalr

Poetry​

poetry add aiosignalr

Requirements​

  • Python 3.11 or newer (3.11, 3.12, 3.13, 3.14 are supported).

  • The following dependencies are installed automatically:

    PackageVersionPurpose
    aiohttp>=3.9,<4HTTP negotiation, SSE & Long Polling transports
    websockets>=16,<17WebSocket transport
    msgpack>=1.0,<2MessagePack protocol encoding

Verify the installation​

import aiosignalr

print(aiosignalr.__version__ if hasattr(aiosignalr, "__version__") else "ok")

Or simply import the two top-level modules:

from aiosignalr.client import HubConnection
from aiosignalr.server import Hub, SignalRServer

Development installation​

To hack on aiosignalr itself, clone the repository and install the dev dependencies:

git clone https://github.com/TrueRou/aiosignalr.git
cd aiosignalr
uv sync          # installs runtime + dev dependencies

Run the checks:

uv run ruff format .
uv run ruff check .
uv run mypy src
uv run pytest                 # self-tests
uv run pytest tests/interop   # interop tests (requires dotnet)

Next steps​