Installation

hare-orm installs from PyPI with pip; the drivers and integrations it doesn't need for SQLite come as extras. Once it is installed, Your first model defines a model, creates its table and runs the first queries.

pip install hare-orm

hare.__version__ is the version installed.

Optional extras:

pip install hare-orm[asyncpg]        # the pure-Python PostgreSQL driver, instead of the Rust one
pip install hare-orm[clickhouse-connect]  # the ClickHouse dialect over HTTP (clickhouse-connect)
pip install hare-orm[clickhouse-driver]   # the ClickHouse dialect over the native TCP protocol (clickhouse-driver)
pip install hare-orm[sqlite-vec]     # vector search on SQLite (sqlite-vec)
pip install hare-orm[ipython]        # `hare shell` with IPython
pip install hare-orm[tzlocal]        # the machine's own zone for date/time functions on PostgreSQL and ClickHouse with use_timezone=False
pip install hare-orm[encryption]     # EncryptedTextField / EncryptedJSONField
pip install hare-orm[phone]          # PhoneField reading a number in any form (phonenumbers)
pip install hare-orm[opentelemetry]  # an OpenTelemetry span around every query
pip install hare-orm[pydantic]       # JSONField(field_type=...) and hare.contrib.pydantic's schemas of models
pip install hare-orm[yaml]           # a .yml/.yaml config file (PyYAML)
pip install hare-orm[faker]          # Faker() declarations of hare.contrib.factories
pip install hare-orm[request-query]  # hare.contrib.request_query
pip install hare-orm[litestar]       # hare.contrib.frameworks.litestar
pip install hare-orm[fastapi]        # hare.contrib.frameworks.fastapi
pip install hare-orm[robyn]          # hare.contrib.frameworks.robyn
pip install hare-orm[taskiq]         # hare.contrib.taskiq
pip install hare-orm[redis]          # the outbox's RedisWakeup and RedisStreamsDelivery
pip install hare-orm[kafka]          # the outbox's KafkaWakeup and KafkaDelivery
pip install hare-orm[rabbitmq]       # the outbox's RabbitMQWakeup and RabbitMQDelivery
pip install hare-orm[http]           # the outbox's WebhookDelivery
pip install hare-orm[mypy]           # the mypy plugin checking queries (hare.contrib.mypy)
pip install hare-orm[pyright]        # `hare stubs` - stubs of the models for pyright and Pylance
pip install hare-orm[pytest]         # hare's pytest plugin (pytest, pytest-asyncio)

Supported versions

Full support is promised on Linux only: every database below is tested there. On Windows and macOS hare installs and runs for development — the wheels, the CLI and the tests reading no database are checked on all three systems.

Component	Supported	Tested
Python	CPython 3.12, 3.13, 3.14	each of them
PostgreSQL	14 and newer	14, 15, 16, 17 and 18, through rust_pg and through asyncpg, on Linux
PgBouncer	1.22.1 and newer	1.22, 1.23, 1.24, 1.25 and 1.26 in front of PostgreSQL 18, 1.26 also in front of 14, through both drivers, on Linux
SQLite	3.35.5 and newer	3.35.5, 3.37.2, 3.38.0, 3.41.0 and 3.53.4, on Linux
ClickHouse	25.8 and newer	25.8, 25.10, 25.12, 26.3, 26.7, 26.8 and 26.9, a server and a cluster, through clickhouse-connect and clickhouse-driver, on Linux
Redis (outbox)	7.2 and newer	7.2 and 8.10, on Linux
RabbitMQ (outbox)	4.0 and newer	4.0 and 4.3, on Linux
Kafka (outbox)	3.9 and newer	3.9 and 4.3, on Linux

The whole matrix runs on every pull request into dev, every week and before a release — each version of each row at least once.

A server older than the oldest supported version is refused when the connection opens. A feature that a newer version brings (PostgreSQL MERGE from 15, SQLite STRICT tables from 3.37, ...) is turned on by the version of the server the connection talks to — see The server version.

The lowest versions of the dependencies that pyproject.toml declares are tested too, on each Python.

Wheels

The Rust PostgreSQL driver, the Rust row readers/writers and the compiled SQLite functions (the rust.native extension) come prebuilt in a wheel per Python version — cp312, cp313 and cp314 — for each platform:

Platform	Architectures	Wheel tag
Linux, glibc 2.17 and newer	x86-64, ARM64	manylinux_2_17 (manylinux2014)
Linux, musl 1.2 and newer (Alpine)	x86-64, ARM64	musllinux_1_2
macOS	Intel (x86-64), Apple Silicon (ARM64)	macosx
Windows	x64, ARM64	win_amd64, win_arm64

On any other platform pip installs the pure wheel (py3-none-any), without the extension: SQLite (with the Python versions of its functions) and postgresql+asyncpg:// work there, and a postgresql:// connection raises ConfigurationError. See PostgreSQL: the drivers.