Skip to main content

A Python wrapper for the Hypixel API

Project description

hypixel.py (alpha)

Discord Server Hit Counter Documentation Status License

An asynchronous, feature-rich, Hypixel API wrapper for Python

Why hypixel.py?

Blazing fast.

Hypixel.py is fast and lightweight, using built in functions 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/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 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 documentation!

Python 3.7 or higher is required (3.8+ recommended).

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

You can also add [speed] after hypixel.py to install additional packages to enhance aiohttp performance automatically.

    pip install hypixel.py[speed]

Optional Packages

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('duhby')
            print(f'[{player.bedwars.level}✫] [{player.rank}] {player.name}')
        except HypixelException as error:
            print(error)

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

More examples are available here.

Links

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

hypixel.py-0.1.2.tar.gz (20.1 kB view hashes)

Uploaded Source

Built Distribution

hypixel.py-0.1.2-py3-none-any.whl (35.0 kB view hashes)

Uploaded Python 3

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