hare-orm 0.9.0__tar.gz

hare_orm-0.9.0/LICENSE

@@ -0,0 +1,27 @@
+MIT License
+
+Copyright (c) 2026 Vladislav Yaremenko and hare-orm contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+hare-orm began as a fork of Tortoise ORM and vendors an adapted copy of
+PyPika's query-builder internals (see NOTICE.md for the required Apache
+License 2.0 attribution covering both).

hare_orm-0.9.0/NOTICE.md

@@ -0,0 +1,96 @@
+# Third-party notices
+
+[Русская версия](NOTICE.ru.md)
+
+hare-orm is MIT-licensed (see [LICENSE](LICENSE)), but it began life as a fork of, and still
+carries adapted code from, two Apache License 2.0 projects, and parts of its Rust PostgreSQL
+driver are adapted from an MIT-licensed one. Both licenses allow this as long as the original
+copyright and license notices are kept for the carried-over portions. That's what this file does.
+
+## Tortoise ORM
+
+hare-orm's model layer, migration system, and general API shape (`Model`, `QuerySet`, `Meta`,
+field types, the CLI) started as a fork of [Tortoise ORM](https://github.com/tortoise/tortoise-orm).
+Large parts have since been substantially rewritten or replaced (the query engine, the dialect
+system, the Rust PostgreSQL driver, composite primary keys, versioning, soft delete, the
+constraint/trigger system, and more), but code and design carried over from the original project
+remains subject to its license:
+
+```text
+Copyright (c) Tortoise ORM contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
+
+## PyPika
+
+`hare/sql/` (the internal query builder — `Query`, `Table`, `Field`, `Criterion`, the SQL
+context a dialect renders with) is an adapted copy of [PyPika](https://github.com/kayak/pypika)'s query-construction
+internals, extended with hare-orm-specific dialect and expression support. Also Apache License
+2.0:
+
+```text
+Copyright (c) 2016 KAYAK Germany, GmbH
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
+
+## yara-orm
+
+The Rust PostgreSQL driver (`hare.dialects.postgresql.drivers.rust_pg`, `rust/native/src/pg/`) is
+mostly hare-orm's own code. Its design was inspired by the Rust PostgreSQL backend of
+[yara-orm](https://github.com/vsdudakov/yara-orm), an open-source ORM under the MIT License, and
+these parts of it are adapted from yara-orm's code:
+
+- in `rust/native/src/pg/client.rs` — the TLS connection setup (the certificate checks and the
+  connector built from them) and the unification of parameter types across the rows of
+  `execute_many`;
+- in `rust/native/src/pg/value/` (`mod.rs`, `from_python.rs`, `into_python.rs`) — the base of the
+  `Value` type: its variants and their conversion to and from Python objects;
+- in `rust/native/src/pg/error.rs` — the driver's error type.
+
+Those parts remain subject to its license:
+
+```text
+MIT License
+
+Copyright (c) 2026 yara-orm contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

hare_orm-0.9.0/NOTICE.ru.md

@@ -0,0 +1,98 @@
+# Уведомления о стороннем коде
+
+[English](NOTICE.md)
+
+hare-orm распространяется по лицензии MIT (см. [LICENSE](LICENSE)), но начиналась как форк двух
+проектов под лицензией Apache 2.0 и до сих пор содержит переработанный код из них, а части её
+драйвера PostgreSQL на Rust переработаны из проекта под лицензией MIT. Обе лицензии это разрешают
+при условии, что для перенесённых частей сохранены исходные уведомления об авторских правах и
+лицензии. Этот файл их и сохраняет.
+
+Тексты уведомлений ниже приведены дословно, на языке оригинала.
+
+## Tortoise ORM
+
+Слой моделей hare-orm, система миграций и общий вид API (`Model`, `QuerySet`, `Meta`, типы полей,
+командная строка) начинались как форк [Tortoise ORM](https://github.com/tortoise/tortoise-orm).
+С тех пор большие части существенно переписаны или заменены (движок запросов, система диалектов,
+драйвер PostgreSQL на Rust, составные первичные ключи, версии, мягкое удаление, система ограничений
+и триггеров и многое другое), но код и решения, перенесённые из исходного проекта, остаются под
+его лицензией:
+
+```text
+Copyright (c) Tortoise ORM contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
+
+## PyPika
+
+`hare/sql/` (внутренний построитель запросов — `Query`, `Table`, `Field`, `Criterion`, контекст SQL,
+которым рендерит диалект) — переработанная копия внутреннего устройства построения запросов
+[PyPika](https://github.com/kayak/pypika), дополненная поддержкой диалектов и выражений hare-orm.
+Тоже лицензия Apache 2.0:
+
+```text
+Copyright (c) 2016 KAYAK Germany, GmbH
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
+
+## yara-orm
+
+Драйвер PostgreSQL на Rust (`hare.dialects.postgresql.drivers.rust_pg`, `rust/native/src/pg/`) —
+в основном собственный код hare-orm. Его устройство создано по образцу бэкенда PostgreSQL на Rust
+проекта [yara-orm](https://github.com/vsdudakov/yara-orm), открытой ORM под лицензией MIT, и эти его
+части переработаны из кода yara-orm:
+
+- в `rust/native/src/pg/client.rs` — настройка TLS-подключения (проверки сертификата и сборка
+  подключения по ним) и приведение типов параметров к общему типу по всем строкам `execute_many`;
+- в `rust/native/src/pg/value/` (`mod.rs`, `from_python.rs`, `into_python.rs`) — основа типа
+  `Value`: его варианты и их преобразование в объекты Python и обратно;
+- в `rust/native/src/pg/error.rs` — тип ошибок драйвера.
+
+На эти части по-прежнему распространяется его лицензия:
+
+```text
+MIT License
+
+Copyright (c) 2026 yara-orm contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

hare_orm-0.9.0/PKG-INFO

@@ -0,0 +1,321 @@
+Metadata-Version: 2.3
+Name: hare-orm
+Version: 0.9.0
+Summary: An async Python ORM for PostgreSQL, SQLite and ClickHouse, built with relations in mind
+License: MIT
+Keywords: orm,async,asyncio,database,sql,postgresql,sqlite,clickhouse,asyncpg,aiosqlite,migrations,pydantic,rust
+Author: Vladislav Yaremenko
+Author-email: vlad.yaremenko.98@yandex.ru
+Requires-Python: >=3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Rust
+Classifier: Framework :: AsyncIO
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Database
+Classifier: Typing :: Typed
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Provides-Extra: asyncpg
+Provides-Extra: clickhouse-connect
+Provides-Extra: clickhouse-driver
+Provides-Extra: encryption
+Provides-Extra: fastapi
+Provides-Extra: http
+Provides-Extra: ipython
+Provides-Extra: kafka
+Provides-Extra: litestar
+Provides-Extra: mypy
+Provides-Extra: opentelemetry
+Provides-Extra: phone
+Provides-Extra: pyright
+Provides-Extra: pytest
+Provides-Extra: rabbitmq
+Provides-Extra: redis
+Provides-Extra: request-query
+Provides-Extra: robyn
+Provides-Extra: sqlite-vec
+Provides-Extra: taskiq
+Provides-Extra: tzlocal
+Requires-Dist: aio-pika (>=9.4) ; (python_version < "4.0") and (extra == "rabbitmq")
+Requires-Dist: aiokafka (>=0.12) ; (python_version < "3.14") and (extra == "kafka")
+Requires-Dist: aiokafka (>=0.13) ; (python_version >= "3.14") and (extra == "kafka")
+Requires-Dist: aiosqlite (>=0.22.0,<1.0.0)
+Requires-Dist: anyio (>=4.0.0)
+Requires-Dist: asyncpg (>=0.30.0) ; (python_version < "3.14") and (extra == "asyncpg")
+Requires-Dist: asyncpg (>=0.31.0) ; (python_version >= "3.14") and (extra == "asyncpg")
+Requires-Dist: ciso8601 (>=2.3.2) ; sys_platform != "win32" and implementation_name == "cpython" and python_version < "3.13"
+Requires-Dist: ciso8601 (>=2.3.3) ; sys_platform != "win32" and implementation_name == "cpython" and python_version >= "3.13"
+Requires-Dist: clickhouse-cityhash (>=1.0.2.5) ; (python_version < "3.15") and (extra == "clickhouse-driver")
+Requires-Dist: clickhouse-connect[async] (>=1.10.0) ; (python_version < "3.15") and (extra == "clickhouse-connect")
+Requires-Dist: clickhouse-driver (>=0.2.11) ; (python_version < "3.15") and (extra == "clickhouse-driver")
+Requires-Dist: cryptography (>=42.0) ; extra == "encryption"
+Requires-Dist: fastapi (>=0.135) ; (python_version < "4.0") and (extra == "fastapi")
+Requires-Dist: httpx (>=0.27) ; extra == "http"
+Requires-Dist: ipython (>=8.18.0) ; extra == "ipython"
+Requires-Dist: iso8601 (>=2.1.0,<3.0.0) ; python_version < "4.0"
+Requires-Dist: litestar (>=2.23,<3.0) ; (python_version < "4.0") and (extra == "litestar")
+Requires-Dist: lz4 (>=4.3.3) ; (python_version < "3.13") and (extra == "clickhouse-driver")
+Requires-Dist: lz4 (>=4.4.4) ; (python_version == "3.13") and (extra == "clickhouse-driver")
+Requires-Dist: lz4 (>=4.4.5) ; (python_version >= "3.14") and (extra == "clickhouse-driver")
+Requires-Dist: mypy (>=1.16,!=1.18.1) ; extra == "mypy"
+Requires-Dist: mypy (>=1.16,!=1.18.1) ; extra == "pyright"
+Requires-Dist: nest-asyncio (>=1.6.0) ; extra == "ipython"
+Requires-Dist: opentelemetry-api (>=1.20) ; extra == "opentelemetry"
+Requires-Dist: opentelemetry-sdk (>=1.20) ; extra == "opentelemetry"
+Requires-Dist: orjson (>=3.12.0)
+Requires-Dist: phonenumbers (>=8.13) ; extra == "phone"
+Requires-Dist: pydantic (>=2.10.1) ; (python_version < "3.14") and (extra == "fastapi")
+Requires-Dist: pydantic (>=2.10.1) ; (python_version < "3.14") and (extra == "litestar")
+Requires-Dist: pydantic (>=2.10.1) ; (python_version < "3.14") and (extra == "request-query")
+Requires-Dist: pydantic (>=2.10.1) ; (python_version < "3.14") and (extra == "robyn")
+Requires-Dist: pydantic (>=2.12) ; (python_version >= "3.14") and (extra == "fastapi")
+Requires-Dist: pydantic (>=2.12) ; (python_version >= "3.14") and (extra == "litestar")
+Requires-Dist: pydantic (>=2.12) ; (python_version >= "3.14") and (extra == "request-query")
+Requires-Dist: pydantic (>=2.12) ; (python_version >= "3.14") and (extra == "robyn")
+Requires-Dist: pytest (>=8.2) ; extra == "pytest"
+Requires-Dist: pytest-asyncio (>=1.2) ; extra == "pytest"
+Requires-Dist: redis (>=5.0) ; extra == "redis"
+Requires-Dist: robyn (>=0.88,<0.89) ; (python_version < "4.0") and (extra == "robyn")
+Requires-Dist: sqlite-vec (>=0.1.6) ; extra == "sqlite-vec"
+Requires-Dist: taskiq (>=0.12.2) ; (python_version < "4.0") and (extra == "taskiq")
+Requires-Dist: typing-extensions (>=4.12.0)
+Requires-Dist: tzdata (>=2023.3) ; sys_platform == "win32"
+Requires-Dist: tzlocal (>=5.0) ; extra == "tzlocal"
+Project-URL: Changelog, https://github.com/hare-orm/hare-orm/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://hare-orm.github.io/hare-orm/
+Project-URL: Homepage, https://github.com/hare-orm/hare-orm
+Project-URL: Issues, https://github.com/hare-orm/hare-orm/issues
+Project-URL: Repository, https://github.com/hare-orm/hare-orm
+Description-Content-Type: text/markdown
+
+<h1 align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/hare-orm/hare-orm/17e129097eceb00dbf932c67246dfee9801a96e2/docs/assets/readme-banner-dark.png">
+    <img src="https://raw.githubusercontent.com/hare-orm/hare-orm/17e129097eceb00dbf932c67246dfee9801a96e2/docs/assets/readme-banner-light.png" alt="hare-orm" width="600">
+  </picture>
+</h1>
+
+<p align="center"><a href="https://github.com/hare-orm/hare-orm/blob/17e129097eceb00dbf932c67246dfee9801a96e2/README.ru.md">Русский</a></p>
+
+<p align="center">
+  <a href="https://github.com/hare-orm/hare-orm/actions/workflows/ci.yml"><img src="https://github.com/hare-orm/hare-orm/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://hare-orm.github.io/hare-orm/"><img src="https://img.shields.io/badge/docs-hare--orm.github.io%2Fhare--orm-blue" alt="Docs"></a>
+  <a href="https://github.com/hare-orm/hare-orm/blob/17e129097eceb00dbf932c67246dfee9801a96e2/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
+  <a href="https://github.com/hare-orm/hare-orm/blob/17e129097eceb00dbf932c67246dfee9801a96e2/pyproject.toml"><img src="https://img.shields.io/badge/python-3.12%20%7C%203.13%20%7C%203.14-blue.svg" alt="Python 3.12, 3.13, 3.14"></a>
+</p>
+
+An async Python ORM for PostgreSQL, SQLite and ClickHouse, built with relations in mind. Models are
+plain classes, queries are built lazily through a `QuerySet`, and migrations are generated from the
+changes to the models. Coming from Django? See [Coming from Django](https://hare-orm.github.io/hare-orm/getting-started/coming-from-django/).
+
+- **Fast.** A Rust PostgreSQL driver decodes rows and converts values outside Python, and every
+  query shape is built once: a repeated query only binds its new values — see
+  [Benchmarks](#benchmarks).
+- **Relations done right.** Composite primary keys everywhere — as foreign-key targets too — generic
+  relations made of real foreign keys, `select_related()`/`prefetch_related()` with filters, recursive
+  queries over a tree, and an error instead of a silently inflated aggregate — see
+  [Models and relations](https://hare-orm.github.io/hare-orm/#models-and-relations).
+- **Your schema, declared.** Constraints, partial and expression indexes, triggers, views,
+  materialized views, functions, sequences, row level security policies, grants and partitioning
+  live in the model's `Meta` and are created and changed by migrations — see
+  [The schema in `Meta`](https://hare-orm.github.io/hare-orm/#schema-in-meta).
+- **Application patterns built in.** Soft delete, versioned rows, multi-tenancy (by column, by
+  schema or by row level security), optimistic locking, dirty-field tracking and a transactional
+  outbox are `Meta` options — see [Behavior declared in `Meta`](https://hare-orm.github.io/hare-orm/#behavior-in-meta).
+- **Migrations you can trust.** Detected from the models, checked for operations that lock a busy
+  table, compared with the live database (`hare drift`), and generated from an existing database
+  (`hare inspectdb`) — see [Migrations](https://hare-orm.github.io/hare-orm/#migrations).
+- **Every database on its own terms.** SQLite, PostgreSQL and ClickHouse are dialects built on the
+  public API a third-party package uses; PostgreSQL's types, indexes, PostGIS, pgvector, full-text
+  search and `LISTEN`/`NOTIFY` come with it, and a database lacking a feature raises a clear error
+  instead of returning a wrong result — see [Databases](https://hare-orm.github.io/hare-orm/#databases).
+- **Ready for production.** Observers, OpenTelemetry, SQL comment tags, an N+1 detector, pool
+  metrics, distributed transactions, read replicas and routers, PgBouncer support, Pydantic schemas
+  and Litestar, FastAPI and Robyn integrations — see [Observability](https://hare-orm.github.io/hare-orm/#observability).
+- **Checked before it runs.** A mypy plugin rejects a misspelled filter and types the rows of
+  `values()`; a pytest plugin, factories and query-count assertions cover the tests — see
+  [Testing and type checking](https://hare-orm.github.io/hare-orm/#testing-and-type-checking).
+
+The full tour, area by area, is on the [documentation's home page](https://hare-orm.github.io/hare-orm/).
+
+## Contents
+
+- [Quick start](#quick-start)
+- [Installation](#installation)
+- [Benchmarks](#benchmarks)
+- [Documentation](#documentation)
+- [Versioning and releases](#versioning-and-releases)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Quick start
+
+```bash
+pip install hare-orm
+```
+
+```python
+# library/models.py
+from hare import fields
+from hare.models import Model
+
+
+class Author(Model):
+    id = fields.IntField(primary_key=True)
+    name = fields.CharField(max_length=120)
+
+
+class Book(Model):
+    id = fields.IntField(primary_key=True)
+    author = fields.ForeignKeyField("models.Author", related_name="books")
+    title = fields.CharField(max_length=300)
+    rating = fields.IntField(default=0)
+```
+
+```python
+# main.py
+import asyncio
+
+from hare import Hare, HareConfig
+from library.models import Author, Book
+
+
+async def main() -> None:
+    await Hare.init(HareConfig.from_db_url("sqlite+aiosqlite://db.sqlite3", {"models": ["library.models"]}))
+    await Hare.generate_schemas()
+
+    author = await Author.objects.create(name="Ursula K. Le Guin")
+    await Book.objects.create(author=author, title="The Left Hand of Darkness", rating=5)
+
+    async for book in Book.objects.filter(author__name__icontains="le guin").select_related("author"):
+        print(book.title, "—", book.author.name)
+
+    await Hare.close_connections()
+
+
+asyncio.run(main())
+```
+
+A real project keeps its schema in migrations instead of `generate_schemas()`:
+`hare makemigrations`, then `hare migrate`. See
+[Your first model](https://hare-orm.github.io/hare-orm/getting-started/first-model/).
+
+## Installation
+
+```bash
+pip install hare-orm
+
+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
+pip install hare-orm[encryption]     # EncryptedTextField / EncryptedJSONField (Fernet)
+pip install hare-orm[fastapi]        # also: litestar, robyn, request-query, taskiq
+pip install hare-orm[kafka]          # outbox delivery; also: rabbitmq, redis, http
+pip install hare-orm[opentelemetry]  # an OpenTelemetry span around every query
+pip install hare-orm[pytest]         # the pytest plugin; also: mypy, pyright
+pip install hare-orm[ipython]        # `hare shell` with IPython
+```
+
+Every extra is listed under
+[Installation](https://hare-orm.github.io/hare-orm/getting-started/installation/). Requires Python
+3.12, 3.13 or 3.14.
+
+## Benchmarks
+
+<!-- benchmarks:start -->
+hare-orm against SQLAlchemy, tortoise-orm, yara-orm and Django on PostgreSQL, SQLite and ClickHouse,
+on the same scenarios: how many times slower than hare-orm each ORM is on each database, on average,
+and hare-orm's operations per second under load, measured warm — a running application, not one just
+started:
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/hare-orm/hare-orm/17e129097eceb00dbf932c67246dfee9801a96e2/docs/assets/benchmarks/scoreboard-en-dark.svg">
+    <img src="https://raw.githubusercontent.com/hare-orm/hare-orm/17e129097eceb00dbf932c67246dfee9801a96e2/docs/assets/benchmarks/scoreboard-en-light.svg" alt="Times slower than hare-orm, by database" width="800">
+  </picture>
+</p>
+
+Every scenario, the machine and the versions are on the
+[Benchmarks](https://hare-orm.github.io/hare-orm/benchmarks/) pages; the benchmark itself is
+[`benchmarks/bench.py`](https://github.com/hare-orm/hare-orm/blob/17e129097eceb00dbf932c67246dfee9801a96e2/benchmarks/README.md).
+<!-- benchmarks:end -->
+
+## Documentation
+
+**[hare-orm.github.io/hare-orm](https://hare-orm.github.io/hare-orm/)** — the full
+reference: every field type, `Meta` option, `QuerySet` method, migration operation, transaction
+primitive, dialect feature, PostgreSQL type and index, and the exception hierarchy, in English and
+Russian. If you're new to hare-orm, start with
+[Getting Started](https://hare-orm.github.io/hare-orm/getting-started/installation/).
+
+To build and browse it locally instead (e.g. to preview an unreleased change):
+
+```bash
+poetry install
+poetry run mkdocs serve
+```
+
+## Versioning and releases
+
+hare-orm follows [Semantic Versioning](https://semver.org/). Its public API is what the
+[documentation](https://hare-orm.github.io/hare-orm/) describes; undocumented names and names
+with a leading underscore are internal and may change in any release.
+
+Before 1.0.0 the API is still settling:
+
+- a **patch** release (`0.9.1`) only fixes bugs;
+- a **minor** release (`0.10.0`) adds features and may change or remove public API. Every such
+  change is listed under *Breaking changes* in that release's [CHANGELOG](https://github.com/hare-orm/hare-orm/blob/17e129097eceb00dbf932c67246dfee9801a96e2/CHANGELOG.md) entry. A
+  renamed or removed name is gone in that same release — hare-orm doesn't keep deprecated aliases.
+
+From 1.0.0 on, breaking changes land only in a major release. Pin the minor version you tested
+against (`hare-orm>=0.9,<0.10`) and read the changelog before moving to the next one.
+
+Each release is tagged `vX.Y.Z`, published to [PyPI](https://pypi.org/project/hare-orm/) and to
+[GitHub Releases](https://github.com/hare-orm/hare-orm/releases), and described in
+[CHANGELOG.md](https://github.com/hare-orm/hare-orm/blob/17e129097eceb00dbf932c67246dfee9801a96e2/CHANGELOG.md). Work in progress lives on the `dev` branch; `main` points at the
+latest release.
+
+### Supported versions
+
+| Component | Supported |
+| --- | --- |
+| hare-orm | The latest minor release; fixes ship as its patch releases |
+| Python | CPython 3.12, 3.13, 3.14 |
+| SQLite | 3.35.5+ |
+| PostgreSQL | 14+ |
+| PgBouncer | 1.22.1+ |
+| ClickHouse | 25.8+ |
+| Redis, RabbitMQ, Kafka (outbox) | 7.2+, 4.0+, 3.9+ |
+
+Full support is promised on Linux only: the databases are 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.
+
+Dropping a Python or database version is a breaking change and is announced in the changelog.
+Security fixes follow [SECURITY.md](https://github.com/hare-orm/hare-orm/blob/17e129097eceb00dbf932c67246dfee9801a96e2/SECURITY.md).
+
+## Contributing
+
+Bug reports, feature proposals and pull requests are welcome. [CONTRIBUTING.md](https://github.com/hare-orm/hare-orm/blob/17e129097eceb00dbf932c67246dfee9801a96e2/CONTRIBUTING.md)
+covers the dev environment, the test matrix (SQLite, PostgreSQL via
+`asyncpg` and via the Rust driver, PgBouncer, ClickHouse), code style, how a change gets reviewed and
+merged, and the sign-off every commit needs.
+
+## License
+
+MIT — see [LICENSE](https://github.com/hare-orm/hare-orm/blob/17e129097eceb00dbf932c67246dfee9801a96e2/LICENSE). `hare-orm` began as a fork of Tortoise ORM and vendors an adapted
+copy of PyPika's query-builder internals; both are Apache License 2.0. The Rust PostgreSQL driver
+was inspired by the one in [yara-orm](https://github.com/vsdudakov/yara-orm), an open-source ORM
+under the MIT License, and adapts parts of its code. The required notices of all three live in
+[NOTICE.md](https://github.com/hare-orm/hare-orm/blob/17e129097eceb00dbf932c67246dfee9801a96e2/NOTICE.md).
+