A modern efficient and faster way of interacting with the Hypixel API!
Project description
__ __ _ __ ________
/ / / /_ ______ (_) _____ / / / _/ __ \
/ /_/ / / / / __ \/ / |/_/ _ \/ / / // / / /
/ __ / /_/ / /_/ / /> </ __/ / _/ // /_/ /
/_/ /_/\__, / .___/_/_/|_|\___/_/ /___/\____/
/____/_/
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)
▶ Documentation for the API
API-Help section: https://hypixel.net/threads/guide-using-the-hypixel-api-with-python.2596749/
🤝 Contributing
Contributions, issues and feature requests are welcome. After cloning & setting up project locally, you can just submit a PR to this repo and it will be deployed once it's accepted.
⚠️ It’s good to have descriptive commit messages, or PR titles so that other contributors can understand about your commit or the PR Created. Read conventional commits before making the commit message.
And, Also we have a Branch named dev
, So if you're interested in contributing, Please contribute to that branch instead of the main
branch.
🙌 Show your support
Be sure to leave a ⭐️ if you like the project!
📢 Changelog
If you're interested in seeing the Changelog, Go here!
Made by janaSunrise with ❤
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 Distribution
Built Distribution
Hashes for HypixelIO-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be9fbe872869da0ad71d2234dd72d661f8f086c8a1f97d839cc0d4bd3382d75a |
|
MD5 | 706acfb268d5fc4bf3dab456d867949a |
|
BLAKE2b-256 | 07db3270494e9bfda64c53c8b26644e425e0e7702dcb98d555e73f9792da6b8f |