Add install steps

This commit is contained in:
2025-07-12 01:14:30 +03:00
parent aac0a97101
commit 8a25d234c8

View File

@@ -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`-типы через ретрай на выбросе исключения
- по умолчанию использует готовый щаблон для кодогенерации и исполняет его по запросу, требуется особое внимание к сохранности данного шаблона
- не проверяет типы списков, словарей, кортежей (реализация ожидается)
- пользовательские проверки типов должны быть реализованы через наследование и проверки в конструкторе
- пользовательские проверки типов должны быть реализованы через наследование и проверки в конструкторе
----
### Как установить:
#### [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
```