From 8a25d234c8cc6c69e5e49a82e485babf2f9d9c9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=90=D1=80=D1=82=D1=83=D1=80=20=D0=A8=D0=B5=D0=B2=D1=87?= =?UTF-8?q?=D0=B5=D0=BD=D0=BA=D0=BE?= Date: Sat, 12 Jul 2025 01:14:30 +0300 Subject: [PATCH] Add install steps --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4c5c294..cbd939b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # megasniff ### Автоматическая валидация данных по схеме и сборка объекта в одном флаконе -Как применять: +#### Как применять: ```python # 1. Объявляем схемы from __future__ import annotations @@ -37,4 +37,22 @@ fn({'a': 1, 'b': 2, 'c': {'field1': {}, 'field2': '1.1'}}) - проверяем `Union`-типы через ретрай на выбросе исключения - по умолчанию использует готовый щаблон для кодогенерации и исполняет его по запросу, требуется особое внимание к сохранности данного шаблона - не проверяет типы списков, словарей, кортежей (реализация ожидается) -- пользовательские проверки типов должны быть реализованы через наследование и проверки в конструкторе \ No newline at end of file +- пользовательские проверки типов должны быть реализованы через наследование и проверки в конструкторе + +---- + +### Как установить: +#### [uv](https://docs.astral.sh/uv/concepts/projects/dependencies/#dependency-sources): +```bash +uv add megasniff --index sniff_index=https://git.nikto-b.ru/api/packages/nikto_b/pypi/simple +``` + +#### [poetry](https://python-poetry.org/docs/repositories/#private-repository-example): +1. Добавить репозиторий в `pyproject.toml` +```bash +poetry source add --priority=supplemental sniff_index https://git.nikto-b.ru/api/packages/nikto_b/pypi/simple +``` +2. Поставить пакет +```bash +poetry add --source sniff_index megasniff +``` \ No newline at end of file