Skip to main content

pykagapi - python wrapper for King Arthur's Gold-related APIs

Project description

pykagapi

Description:

pykagapi - is a python wrapper for King Arthurs Gold-related apis (kag api v1 and kagstats api). Use it as you please.

Dependencies:

  • python 3.10 (may work on previous versions, didnt test)
  • requests

Example Usage:

Getting general api info:

from pykagapi import kag

with kag.get_client() as c:
    print(c.get_api_info())

Getting amount of currently active servers:

from pykagapi import kag

with kag.get_client() as c:
    servers_amount = len(kag.extra.get_active_servers()["serverList"])

print(f"There are currently {servers_amount} servers with players!")

Example output: There are currently 6 servers with players!

Currently unimplemented api calls:

KAG API:

  • Everything that isn't "get" requests, because Im just a regular player and dont have ability to upload or remove anything

KAGSTATS API:

  • https://kagstats.com/api/players, because there are few thousand players known to database. Do you really need to get them all?
  • https://kagstats.com/api/players/{id}/refresh, because it doesnt seem to do anything
  • Whatever I didnt notice while casually reading api's source codes

TODO:

  • Support for non-GET requests
  • Async clients
  • Automated tests

LICENSE:

WTFPL

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

pykagapi-0.3.0.tar.gz (5.3 kB view hashes)

Uploaded Source

Built Distribution

pykagapi-0.3.0-py3-none-any.whl (6.9 kB view hashes)

Uploaded Python 3

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