hypixel.py 0.2.1

A Python wrapper for the Hypixel API

A modern, asynchronous, feature-rich, Hypixel API wrapper for Python.

Why hypixel.py?

Blazing fast.

Hypixel.py is fast and lightweight, using built in libraries to achieve async timed lru caching, fast nested dataclass json sterilization, modern sane rate limit handling, and more.

Fully asynchronous.

Hypixel.py is fully asynchronous and uses modern async and await python syntax. This means your program won’t have to wait for your api requests to finish before running any more code.

Minimal depdencies.

Hypixel.py uses built in libraries for everything possible so you don’t need to worry about relying on more libraries than necessary.

Marvelously clean syntax.

Hypixel.py uses object oriented pythonic dot syntax for all of its models, so you can easily access any data point without worrying about dictionaries and strings.

Highly maintained documentation.

Hypixel.py’s documentation is highly maintained and provides a plentiful amount of examples to get you started.

Getting Started

Check out the examples and documentation!

Python 3.7+ is required (3.9+ recommended)

Installation

To install hypixel.py, simply install it from pypi under the name hypixel.py with pip or your favorite package manager.

pip install hypixel.py --upgrade

You can also append [speed] to install optional packages (see below) to enhance aiohttp and json performance automatically.

pip install hypixel.py[speed] --upgrade

Optional Packages

To ehnahce aiohttp performance:

• aiodns

• brotlipy

• cchardet

To enhance json decoding (up to 4x faster):

• ujson

Warning

If you are running python version 3.8 or higher on Windows, then you must add the following code before you start an event loop (asyncio.run):

asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())

Quick Example

import hypixel
from hypixel import HypixelException
import asyncio

async def main():
    client = hypixel.Client('api-key')
    async with client:
        try:
            player = await client.player('gamerboy80')
            print(f'[{player.bedwars.level}✫] [{player.rank}] {player.name}')
        except HypixelException as error:
            print(error)

if __name__ == '__main__':
    asyncio.run(main())

You can find more examples here