Add install steps
This commit is contained in:
22
README.md
22
README.md
@@ -1,6 +1,6 @@
|
|||||||
# megasniff
|
# megasniff
|
||||||
### Автоматическая валидация данных по схеме и сборка объекта в одном флаконе
|
### Автоматическая валидация данных по схеме и сборка объекта в одном флаконе
|
||||||
Как применять:
|
#### Как применять:
|
||||||
```python
|
```python
|
||||||
# 1. Объявляем схемы
|
# 1. Объявляем схемы
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -37,4 +37,22 @@ fn({'a': 1, 'b': 2, 'c': {'field1': {}, 'field2': '1.1'}})
|
|||||||
- проверяем `Union`-типы через ретрай на выбросе исключения
|
- проверяем `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
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user