Skip to main content

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.

Metadata

Release files for kickthespypet-api 0.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kickthespypet-api 0.0.5
File Size Uploaded
kickthespypet_api-0.0.5.tar.gz 9.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kickthespypet-api 0.0.5
File Interpreter ABI Platform
kickthespypet_api-0.0.5-py3-none-any.whl Python 3 none any Details

Total release size: 19.1 kB

Release files / kickthespypet_api-0.0.5.tar.gz

Download URL kickthespypet_api-0.0.5.tar.gz
Size 9.2 kB
Tags Source
SHA-256 checksum
How to use checksums
d048f299b8511518fa1810592d2572b44648e046dd9545130e61dbbd6565c09e
BLAKE2b-256 checksum
How to use checksums
4b88f10527591e314e5e5e552a85ad74c2e781c7c71991180cb42969934275bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.12.2 Windows/11

Release files / kickthespypet_api-0.0.5-py3-none-any.whl

Download URL kickthespypet_api-0.0.5-py3-none-any.whl
Size 9.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4de475ce2e06a0b5ce6424eeba16e450de05aba1cd827bf34a71d31db0d7ebb1
BLAKE2b-256 checksum
How to use checksums
5ef655437f1543d6ff06f857c650d3616c899176fb7ef378187e21c9bf172d09
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.12.2 Windows/11

Release history Release notifications | RSS feed

This release

0.0.5 This release

2 release files

0.0.4

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page