HypixelIO 0.0.5

A modern efficient and faster way of interacting with the Hypixel API!

    __  __            _           __   ________ 
   / / / /_  ______  (_)  _____  / /  /  _/ __ \
  / /_/ / / / / __ \/ / |/_/ _ \/ /   / // / / /
 / __  / /_/ / /_/ / />  </  __/ /  _/ // /_/ / 
/_/ /_/\__, / .___/_/_/|_|\___/_/  /___/\____/  
      /____/_/                                  

A Modern Efficient and Easy way of interacting with the Hypixel API!

Installing

Note: Python 3.6 or above is required!

# Windows
py -3 -m pip install -U HypixelIO

# Linux or MacOS
python3 -m pip install -U HypixelIO

# Install the development version
python3 -m pip install -U git+https://github.com/janaSunrise/HypixelIO

Usage

from hypixelio import Client, Converters

client = Client(api_key="your-api-key")

boosters = client.get_boosters()  # Get the boosters object

friends = client.get_friends(uuid="user's-uuid")  # Returns the Friends object
# or if you don't know the UUID
friends = client.get_friends(uuid=Converters.username_to_uuid("your-username"))

print(boosters[0].ID)
print(friends.FRIENDS[0].RECEIVER_ID)

Implementing caching with the Requests.

from hypixelio import Client, Converters, Caching, CacheBackend

config = Caching("cache", CacheBackend.memory, 100, False)

client = Client(api_key="your-api-key", cache=True, cache_config=config)

boosters = client.get_boosters()

print(boosters[0].ID)

TODOs PLANNED

• Implement Games and leaderboard Models in searching
• Add Examples for using the code in README.md
• Add boosters API Section
• Add Resources API Section
• Add Skyblock API Section
• Add Find guild API Section
• Converters like - UUID to Username - Username to UUID
• Fix __repr__ and __str__
• Implement caching for efficiency
• Allow To opt for, or out of caching, Using Variables in __init__ of Client class
• Allow users to compare two objects, and override in code by extending them.

If you're interested in seeing the Changelog, Go here!

API-Help section: https://hypixel.net/threads/guide-using-the-hypixel-api-with-python.2596749/

Made by janaSunrise with ❤