mirror of
https://github.com/deesiigneer/pyspapi.git
synced 2026-04-20 04:25:25 +00:00
d36ecfca36
- Добавлены классы исключений SPAPIError и ValidationError для улучшенной обработки ошибок API - В APISession добавлен параметр raise_exception, который позволяет выбрасывать исключения при ошибках API - Обновлены методы request, get, post, put для поддержки raise_exception - Расширена модель SPAPI с передачей параметра raise_exception refactor(api, models): улучшена структура кода и модели данных - Упрощена и улучшена реализация APISession, исправлены устаревшие методы и типы - Модель City переработана: добавлены новые поля (nether_x, nether_z, lane, role, created_at), улучшены свойства и __repr__ - Исправлена модель Card (исправлено имя класса с Cards на Card) - В модели Account добавлено поле minecraftuuid, заменено поле city на cities с поддержкой списка объектов City - Исправлены типы возвращаемых значений и добавлены аннотации типов в ключевых местах - Устранены дублирования и улучшена читаемость кода - Комментарии и докстринги уточнены и унифицированы fix(api): исправлены ошибки и опечатки в коде - Исправлено использование устаревших методов для запросов к API - Удалены лишние пустые строки и форматирование под PEP8 Fixes #16 Signed-off-by: deesiigneer <goldenrump@gmail.com>
.. image:: https://raw.githubusercontent.com/deesiigneer/pyspapi/main/assets/repo-banner.png
:alt: pyspapi
.. image:: https://img.shields.io/discord/850091193190973472?color=5865F2&label=discord
:target: https://discord.gg/VbyHaKRAaN
:alt: Discord server invite
.. image:: https://img.shields.io/github/v/release/deesiigneer/pyspapi?include_prereleases&label=github%20release
:target: https://github.com/deesiigneer/pyspapi/
:alt: GitHub release (latest by date including pre-releases)
.. image:: https://img.shields.io/pypi/v/pyspapi.svg
:target: https://pypi.org/project/pyspapi/
:alt: PyPI downloads info
.. image:: https://img.shields.io/pypi/dm/pyspapi?color=informational&label=pypi%20downloads
:target: https://pypi.org/project/pyspapi/
:alt: PyPI version info
.. image:: https://img.shields.io/readthedocs/pyspapi
:target: https://pyspapi.readthedocs.io/
:alt: pyspapi documentation
pyspapi
========
`API <https://github.com/sp-worlds/api-docs>`_ wrapper for SP servers written in Python.
Installation
-------------
**Requires Python 3.8 or higher**
*Windows*
.. code:: sh
pip install pyspapi
*Linux/macOS*
.. code:: sh
pip3 install pyspapi
Quick example
--------------
Checking the balance
~~~~~~~~~~~~~~~~~~~~~
.. code:: py
from pyspapi import SPAPI
from asyncio import get_event_loop
spapi = SPAPI(card_id='CARD_ID', token='TOKEN')
async def main():
print(await spapi.balance)
loop = get_event_loop()
loop.run_until_complete(main())
More examples can be found in the `examples <https://github.com/deesiigneer/pyspapi/tree/main/examples>`_
Links
------
- `Discord server <https://discord.gg/VbyHaKRAaN>`_
- `pyspapi documentation <https://pyspapi.readthedocs.io/>`_
- `PyPi <https://pypi.org/project/pyspapi/>`_
- `API documentation for SP sites <https://github.com/sp-worlds/api-docs>`_