Skip to main content

Python API Client for Mirapolis VirtualRoom. Based on original documentation. Uses Pydantic and aiohttp.

Project description

# Python-клиент для Mirapolis Virtualroom

## Клиент находится в разработке!

### Особенности

Клиент полностью асинхронный с поддержкой валидации Pydantic. Требуется Python 3.12 или выше. Основан на `aiohttp` и `pydantic`.
> Сделан на основе документации: https://support.mirapolis.ru/mira-support/#&step=1&name=%5B01004%5D%5BИнструкция%5D%5BОписание+API%5D%5BUSER%5D%5BF%5D%5B2_44%5D&doaction=Go&s=IZ8RV4AEFDzTTMKY9PgS&id=69&type=mediapreview

### Установка

```console
$ pip install mirapolis-virtualroom
```

### Использование
```Python
from mirapolis_virtualroom.virtualroom_api import VirtualRoom
import asyncio
import logging


# Инициализация клиента
mirapolis_api = VirtualRoom(
app_id="test",
secret_key="secret_key",
base_link="https://v1234.vr.mirapolis.ru/mira"
)


async def main():
# Получение списка мероприятий
measures = await mirapolis_api.get_measures(
limit=10, # Количество на одной странице
offset=40, # Сдвиг страницы
)
for measure in measures:
# Полный вывод
print(repr(measure))
# Краткий вывод (строка)
print(measure)
# Получение названия
print(measure.mename)
# Получение общего количества мероприятий
print(f"{measures.count=}")


if __name__ == '__main__':
logging.basicConfig(level="INFO")
asyncio.run(main())
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mirapolis_virtualroom-0.1.6.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

mirapolis_virtualroom-0.1.6-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file mirapolis_virtualroom-0.1.6.tar.gz.

File metadata

  • Download URL: mirapolis_virtualroom-0.1.6.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/6.9.10-1-MANJARO

File hashes

Hashes for mirapolis_virtualroom-0.1.6.tar.gz
Algorithm Hash digest
SHA256 d3e6f9d542b250e2537121d2657ad38728db496fed0c3409dc620966a25d7fad
MD5 330939dfbe5a820282c4d5a93eb34ed4
BLAKE2b-256 d3e9fd87e6501ea85f2721dc07842fcfc6b3b2e89b808f1f34fe430305d95910

See more details on using hashes here.

File details

Details for the file mirapolis_virtualroom-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for mirapolis_virtualroom-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 cf5adb7eaecf2c137cc81fe3dc5e24e420599c6eb525c7646735508ae9867f16
MD5 692a749352e11fcbf7a49e29f0af1359
BLAKE2b-256 34b9d03de4faa5f28f23212386190373681464b1f2347e8c169d8f708f71565c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page