Skip to main content

minecraftstatus is an asynchronous wrapper for https://api.iapetus11.me.

Project description

An async API wrapper around api.iapetus.me

Get started

to get started, type this in your terminal

pip install -U minecraftstatus

or to install the main branch

pip install -U git+https://github.com/Infernum1/minecraftstatus
(make sure you have git installed)

Example

Getting info on a Minecraft Server.
import asyncio
import minecraftstatus

client = minecraftstatus.MCStatus()

async def main(ip_address: str):
    server = await client.get_server(ip_address)
    print(server.motd)
    print(server.players_online)
    print(server.max_players)
    print(server.version) # and many more attributes!

if __name__ == "__main__":
    asyncio.run(main("mc.hypixel.net"))
Getting a custom achievement image.
import asyncio
import minecraftstatus

client = minecraftstatus.MCStatus()

async def main(achievement: str):
    image = await client.achievement(achievement)
    print(await image.getvalue())

if __name__ == "__main__":
    asyncio.run(main("Mom, get the camera!!!"))
Getting a custom splash text image.
import asyncio
import minecraftstatus

client = minecraftstatus.MCStatus()

async def main(text: str):
    image = await client.splash_text(text)
    print(await image.getvalue())

if __name__ == "__main__":
    asyncio.run(main("Also check out terarria"))
Or if you plan to use it in a discord bot
import discord
import minecraftstatus

client = minecraftstatus.MCStatus()
bot = discord.ext.commands.Bot()

@bot.command()
async def achievement(achievement: str):
  image = await client.achievement(achievement)
  file = discord.File(image, "achievement.png")
  await ctx.send(file=file)
these are just examples! it's upto you how you want to use this lib.

Join the discord server for support.

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

minecraftstatus-0.0.5.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

minecraftstatus-0.0.5-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: minecraftstatus-0.0.5.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.0 Windows/10

File hashes

Hashes for minecraftstatus-0.0.5.tar.gz
Algorithm Hash digest
SHA256 9d070a23361479c98e4aac9b84845a822d2be5df4aee12111b7d05d709a38149
MD5 a4418a62280ba1aa30c0db94cdd77f1e
BLAKE2b-256 905b6973b2006f05fe9328406b8963d055d7dd62a7b5bb71070961a32e3a30ca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: minecraftstatus-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.0 Windows/10

File hashes

Hashes for minecraftstatus-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 12a720e36b808e52c1315dbd926a4043c9385ee3312725c13fc8640961188e98
MD5 5b71e260a3c1ed21c8ea382338d6475a
BLAKE2b-256 31cb04870272c95b6b76bc46c9e5ed77635b5bf9f9fb6c9711b273ff0cb446df

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