Skip to main content

kickthespy.pet API wrapper

Project description

kickthespypet-api

A kickthespy.pet API wrapper for Python with fully documented and type-annotated. All API are made using the javascript file from the website

Installing

pip install git+https://github.com/timelessnesses/kickthespypet-api
# or
pip install kickthespypet-api

Examples

import kickthespypet_api

client = kickthespypet_api.KickTheSpyPetAPI()
client.get_bot_by_server_id(20).id
client.get_bot_by_server_invite("server invite here")
for bot in client.get_bot_user_ids_int():
    await (await bot_client.fetch_user(bot)).ban()\
client.close()

# or you can use `with`

with kickthespypet_api.KickTheSpyPetAPI() as client:
    # do stuff
# closed automatically once done

Async:

import kickthespypet_api

client = kickthespypet_api.AsyncKickTheSpyPetAPI()
stuff = await client.get_bot_by_server_id(1000)
print(stuff)
await client.close()

# or you can use `async with`

async with kickthespypet_api.AsyncKickTheSpyPetAPI() as client:
    # do stuff
# closed automatically once done

AsyncKickTheSpyPetAPI is same API as KickTheSpyPetAPI but all of HTTP requests will be made with aiohttp instead of requests and they are asynchronous so you need to await.
Reminder: if you don't use (async) with, you need to close the session by yourself.

This is NOT fully documented and STABLE

Due to kickthespy.pet doesn't have official documentation on their responses, I really can't document every values or states that kickthespy.pet can send. Please open pull request for that if you know it's type and documentation. Check out at kickthespypet_api/types.py for list of Unknown types and unknown documentation of the value.

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

kickthespypet_api-0.0.5.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

kickthespypet_api-0.0.5-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file kickthespypet_api-0.0.5.tar.gz.

File metadata

  • Download URL: kickthespypet_api-0.0.5.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.2 Windows/11

File hashes

Hashes for kickthespypet_api-0.0.5.tar.gz
Algorithm Hash digest
SHA256 d048f299b8511518fa1810592d2572b44648e046dd9545130e61dbbd6565c09e
MD5 084ef04bb04d25f3c59d7645be5353a3
BLAKE2b-256 4b88f10527591e314e5e5e552a85ad74c2e781c7c71991180cb42969934275bd

See more details on using hashes here.

File details

Details for the file kickthespypet_api-0.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for kickthespypet_api-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4de475ce2e06a0b5ce6424eeba16e450de05aba1cd827bf34a71d31db0d7ebb1
MD5 7d7e3ba69daa66694585de93741ac15e
BLAKE2b-256 5ef655437f1543d6ff06f857c650d3616c899176fb7ef378187e21c9bf172d09

See more details on using hashes here.

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