https://github.com/barsikus007/boosty

asynchronous boosty api wrapper
https://github.com/barsikus007/boosty

async asyncio boosty python

Last synced: about 1 year ago
JSON representation

asynchronous boosty api wrapper

• Host: GitHub
• URL: https://github.com/barsikus007/boosty
• Owner: barsikus007
• License: mit
• Created: 2023-03-14T07:47:41.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2025-03-26T07:27:59.000Z (about 1 year ago)
• Last Synced: 2025-03-31T04:05:28.822Z (about 1 year ago)
• Topics: async, asyncio, boosty, python
• Language: Python
• Homepage:
• Size: 152 KB
• Stars: 44
• Watchers: 7
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README-ru.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

    

  



# Обертка для Boosty

[![PyPI - Version](https://img.shields.io/pypi/v/boosty.svg)](https://pypi.org/project/boosty)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/boosty.svg)](https://pypi.org/project/boosty)

[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)

-----

**[English description](https://github.com/barsikus007/boosty/blob/master/README.md)**

**Содержание**

- [Установка](#установка)

- [Лицензия](#лицензия)

- [Использование](#использование)

## Установка

```console

pip install boosty

```

## Лицензия

`boosty` распространяется на условиях лицензии [MIT](https://spdx.org/licenses/MIT.html).

> [!IMPORTANT]

> **!ВНИМАНИЕ! эта версия библиотеки очень нестабильна (в новых версиях возможны радикальные изменения в API и зависимостях)**

>

> **Если вы используете ее, свяжитесь с мейнтейнером, чтобы помочь сделать ее стабильной**

## Использование

*Необязательно:* укажите переменную среды `IGNORE_MISSING_AND_EXTRA_FIELDS` чтобы отключить строгую проверку схемы

```py

# или пропишите эти строки перед первым импортом boosty

import os

os.environ["IGNORE_MISSING_AND_EXTRA_FIELDS"] = "true"

```

*Необязательно:* заполните файл `auth.json` данными аутентификации (или используйте [браузерную аутентификацию](https://github.com/barsikus007/boosty/blob/master/examples/browser_auth.py) чтобы их создать):

```json

{

  "access_token": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",

  "device_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",

  "expires_at": 12345678900,

  "refresh_token": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"

}

```

Пример:

```python

import asyncio

from boosty.api import API

async def main():

    api = API()

    response = await api.get_post("boosty", post_id="c9fb8a19-c45e-4602-9942-087c3af28c1b")

    print(response.title)

    # 'Добро пожаловать на борт!'

asyncio.run(main())

```

Больше примеров в папке [examples/](https://github.com/barsikus007/boosty/tree/master/examples/)