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.
🙌 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.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 561d25cdde877c735e5280e2f218571f1aebb8fccf365b1aaad1f3f283039141 |
|
MD5 | f5cd3fca8f04766154e1570d8e49b255 |
|
BLAKE2b-256 | b130f60f0c4184aa9e7e3260c9ffbf8100aeb50975ddaa6e9ab9ee7df13d8cda |