README.md

SpApi - Python библиотека для простого доступа к api серверов #СП

Это переделка библиотеки https://github.com/ronanru/spapi только для Python

Установка

Создаёте в корне своего проекта папку modules в неё cкопируете папку spapi из этого репозитория

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

from modules import spapi # Импортируем

api = spapi.SpApi("spm") # Вместо spm пишете нужный сервер если он есть во вкладке 'Поддерживаемые сервера' тут - https://github.com/ronanru/spapi

Синтаксис и инструкции

data = api.getLastChatMessages(5).messages 

# data - Это переменная, в неё мы записываем значение, которое вернул метод

# api - Обьект api который мы создали выше во вкладке "Использование"

# getLastChatMessages(5) - Метод обьекта api. (Список методов будет ниже.)
# Значение в скобках это аргумент этого метода, тут он означает лимит сообщений

# messages - Это переменная обьекта getLastChatMessages(5)
# тоесть мы хотим от этого метода список сообщений.
# Без него это выглядело бы примерно вот так - <GetLastChatMessages messages='[]'>

Приступим к коду

from modules import spapi

api = spapi.SpApi("spm")


chat         = api.getLastChatMessages(4)
online       = api.getOnlinePlayers()
time         = api.getServerTime()
weather      = api.getServerWeather()

a = input("Введите что вы хотите получить -> ")
if a == "chat":
	print(chat)

elif a == "online":
	print(online)

elif a == "time":
	print(time)

elif a == "weather":
	print(weather)

else:
	print("Таких данных не обнаружено.")

Output

>>> python3 main.py 
 Введите что вы хотите получить -> weather
 <GetServerWeather weather='CLEAR'>

>>> python3 main.py 
 Введите что вы хотите получить -> time
 <GetServerTime timeOfDay='NIGHT', formated='19:33', ticks=12550>

Список методов и описание

getLastChatMessages(4)
# Получить последние сообщения с сервера
#
# Аргументы:
#  limit, первый позициональный аргумент. Влияет на максимальное кол-во возвращаемых сообщений
#    Максимум - 50
#
# Пременные:
#  messages - Список(list) из сообщений
#


getOnlinePlayers()
# Получить онлайн сервера
#
# Переменные:
#  players - Список(list) из словарей с ключами nick & uuid
#  count   - Число(int) показывает текущий онлайн
#  max     - Число(int) показывает максимальный онлайн
#
#


getServerTime()
# Получить текущее время на сервере
#
# Переменные:
#  timeOfDay - Строка(str)  'DAY' или 'NIGHT'
#  ticks     - Число(int)   Время в тиках
#  formated  - Строка(str)  Время в 24 часовом форма
#
#
#
#
#


getServerWeather()
# Получить текущую погоду на сервере
#
# Переменные:
#  weather - Строка(str)  'CLEAR', 'RAIN' или 'THUNDER'
#