An asynchronous wrapper for the Hypixel API.
Project description
PyPixel
An asynchronous wrapper for the Hypixel API.
Installation
Python 3.6 or higher is required
You can install the package with the following command.
# Linux/macOS
python3 -m pip install -U pypixel-api
# Windows
py -3 -m pip install -U pypixel-api
Or, you can install the development version from the GitHub:
# Linux/macOS
python3 -m pip install -U git+https://github.com/plun1331/PyPixel
# Windows
py -3 -m pip install -U git+https://github.com/plun1331/PyPixel
A few examples
Getting a player.
# Import the module
import PyPixel
# Importing asyncio so we can run our coroutine
import asyncio
# Initialize the Hypixel class
hypixel = PyPixel.Hypixel(api_key='YOUR_API_KEY')
async def getPlayer():
# Gets a player by UUID. For this example, we'll use mine.
player = await hypixel.get_player('c7b08e0c73c94750b7780841025f40d4')
print(player.name)
print(player.uuid)
print(player.rank)
# Run the above coroutine
loop = asyncio.get_event_loop()
loop.run_until_complete(getPlayer())
"""
Output:
awsomo28
c7b08e0c73c94750b7780841025f40d4
MVP+
"""
Getting a guild
# Import the module
import PyPixel
# Importing asyncio so we can run our coroutine
import asyncio
# Initialize the Hypixel class
hypixel = PyPixel.Hypixel(api_key='YOUR_API_KEY')
async def getGuild():
# Gets a player by UUID. For this example, we'll use mine.
guild = await hypixel.get_guild('SkyKings', 'name')
print(guild.name)
print(guild.members[0].rank)
print(guild.level)
# Run the above coroutine
loop = asyncio.get_event_loop()
loop.run_until_complete(getGuild())
"""
Output:
SkyKings
GUILDMASTER
98
"""
Changelog
0.1.4a
- Added a changelog
- Introduced SkyBlock Profiles
- Added 3 new fuctions to
.Hypixel
(.get_name(uuid)
,.get_uuid(name)
, and.get_profiles(uuid)
) - Deleted
Other.py
in favor of a submodule,utils
- Moved the
send_request()
method to.Hypixel
and renamed it_send()
- Added a new requirement,
NBT
(Used for parsing NBT data). - Added some exception classes.
- Started subclassing
object
for no paticular reason.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for pypixel_api-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a65b379c605187b7f5a867e3bca23ccdd0e3f56e7643a35a5b9198fe3b78166 |
|
MD5 | 9cb61bb5a14584f3cfb20dd1703fd336 |
|
BLAKE2b-256 | 86fb1ba8b1dcfc2f127c34ccf91cc1523e3216d4b0dd11f2dee904f1d445e473 |