A modern, efficient and faster way of interacting with the Hypixel API!
Project description
__ __ _ __ ________
/ / / /_ ______ (_) _____ / / / _/ __ \
/ /_/ / / / / __ \/ / |/_/ _ \/ / / // / / /
/ __ / /_/ / /_/ / /> </ __/ / _/ // /_/ /
/_/ /_/\__, / .___/_/_/|_|\___/_/ /___/\____/
/____/_/
HypixelIO
A Modern Efficient and Easy way of interacting with the Hypixel API!
Docs · Report a bug · Discussions · Discord
✨ Why choose HypixelIO over others?
- Modern way of handling requests
- Both async and sync support.
- Simple rate handling, and caching.
- Speed optimized
- Easy to use with a modern and simple design
- Full API coverage
🚀 Installing
Note: Python 3.7 or above is required!
# Windows
py -3 -m pip install -U HypixelIO
# Linux or MacOS
python3 -m pip install -U HypixelIO
# Install the nightly build
python3 -m pip install -U git+https://github.com/janaSunrise/HypixelIO
# Or use [speedups] to speed up only for async features
python3 -m pip install -U "HypixelIO[speedups]"
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)
Need async support? We already do!
from hypixelio.ext.asyncio import AsyncClient, AsyncConverters
client = AsyncClient(api_key="your-api-key")
boosters = await client.get_boosters() # Get the boosters object
friends = await client.get_friends(uuid="user's-uuid") # Returns the Friends object
# or if you don't know the UUID
friends = await client.get_friends(uuid=Converters.username_to_uuid("your-username"))
print(boosters[0].ID)
print(friends.FRIENDS[0].RECEIVER_ID)
Find more examples here
🤝 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.
💬 Get in touch
If you have various suggestions, questions or want to discuss things wit our community, Have a look at Github discussions or join our discord server!
📢 Changelog
If you're interested in seeing the Changelog, Go here!
🙌 Show your support
Be sure to leave a ⭐️ if you like the project!
▶ Links
- Official Documentation
- Raise an Issue
- API-Help section: https://hypixel.net/threads/guide-using-the-hypixel-api-with-python.2596749/
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-1.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f41698f198a7bcc503313b3cb5361970ea11b8a5c0c13ff935d7ae233d54a5c5 |
|
MD5 | e7fc42a807424b45df22ec3cfc6c7c5f |
|
BLAKE2b-256 | 1207865882ff8447bcf39842aa36aef4910f9aa00c56b8fd947c9ef82a878b9c |