Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 1.98 KB

README.md

File metadata and controls

80 lines (60 loc) · 1.98 KB

BoostyPy

Boosty Wrapper

PyPI - Version PyPI - Python Version Hatch project


Table of Contents

Installation

pip install boosty

License

boosty is distributed under the terms of the MIT license.

Important

!WARNING! this version of library is very unstable

If you use it, contact maintainer to help make it stable

Usage

Optional: specify IGNORE_MISSING_AND_EXTRA_FIELDS environment variable to disable strict schema validation

Optional: fill auth.json file with authentication data:

{
  "access_token": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
  "device_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
  "expires_at": 12345678900,
  "refresh_token": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
}

Example:

from boosty.api import API

api = API()
response = await api.get_post("boosty", post_id="c9fb8a19-c45e-4602-9942-087c3af28c1b")
print(response.title)
# 'Добро пожаловать на борт!'

More examples in examples/ folder

TODO for stable release

  • api schema
    • add access levels logic for requests
  • minimal docs
  • useful properties for models
  • merge reply comment with comment model
  • add examples
    • render text
    • get video url
    • get comment url
  • add tests
    • boosty profile
    • comments
    • replies
    • video
    • entities parsing