Metadata-Version: 2.4
Name: vkbottle-types
Version: 5.199.99.15
Summary: VK API methods & types for vkbottle.
License-Expression: MIT
License-File: LICENSE
Author: timoniq
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: msgspec (>=0.20.0,<0.21.0)
Requires-Dist: pydantic (>=2.12.5,<3.0.0)
Requires-Dist: typing-extensions (>=4.15.0,<5.0.0)
Requires-Dist: vkbottle (>=4.8.0,<5.0.0)
Description-Content-Type: text/markdown

# vkbottle-types

Библиотека [VK API](https://dev.vk.ru/ru/method) типов и методов для фреймворка [**vkbottle**](https://github.com/vkbottle/vkbottle)

Установить с pypi:

[![pypi](https://img.shields.io/pypi/v/vkbottle-types.svg)](https://pypi.org/project/vkbottle-types/)

```console
pip install vkbottle-types
```

Самую новую версию можно поставить с мастера:

```console
pip install -U https://github.com/vkbottle/vkbottle-types/archive/master.zip
```

Если вы обнаружили баг в типах - не создавайте issue здесь, создайте его в разделе [основного репозитория](https://github.com/vkbottle/vkbottle), добавив тег `vkbottle-types`.

Если вы в состоянии исправить эту проблему сами, то сделайте pull request сами, пожалуйста. Можете упомянуть issue в [основном репозитории](https://github.com/vkbottle/vkbottle).


## Оригинальная схема


[![vk-api](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FVKCOM%2Fvk-api-schema%2Frefs%2Fheads%2Fmaster%2Fpackage.json&query=%24.version&label=vk%20api%20schema
)](https://github.com/VKCOM/vk-api-schema)

## Добавление патча для схемы (WIP)

Из-за того что разработчики вк недобросовестно подходят к публикации схемы и релизам в целом, был сделан патчер схемы.

Для того, чтобы создать новый патч, используется следующая команда:

```console
python3 -m patcher -m "Add users.get missing param_name"
```

## Генерация типов

```console
python -m generator
```

Подробнее как самому сгенерировать типы в [HOWTO](/HOWTO)

