Metadata-Version: 2.1
Name: HypixelIO
Version: 1.3.0
Summary: A modern, efficient and better way of interacting with the Hypixel API!
Home-page: https://github.com/janaSunrise/HypixelIO
Author: Sunrit Jana
Author-email: warriordefenderz@gmail.com
License: MIT
Project-URL: Documentation, https://github.com/janaSunrise/HypixelIO
Project-URL: Issue tracker, https://github.com/janaSunrise/HypixelIO/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Typing :: Typed
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: requests (==2.25.1)
Requires-Dist: aiohttp (==3.7.4.post0)
Requires-Dist: requests-cache (==0.6.3)
Requires-Dist: aiohttp-client-cache (==0.4.0)
Provides-Extra: all
Requires-Dist: aiodns (>=1.1) ; extra == 'all'
Requires-Dist: Brotli (==1.0.9) ; extra == 'all'
Requires-Dist: cchardet (==2.1.7) ; extra == 'all'
Requires-Dist: boto3 (==1.18.4) ; extra == 'all'
Requires-Dist: pymongo (==3.12.0) ; extra == 'all'
Requires-Dist: redis (==3.5.3) ; extra == 'all'
Requires-Dist: aiosqlite (==0.17.0) ; extra == 'all'
Requires-Dist: motor (==2.4.0) ; extra == 'all'
Requires-Dist: aioredis (==1.3.1) ; extra == 'all'
Provides-Extra: async-cache
Requires-Dist: aiosqlite (==0.17.0) ; extra == 'async-cache'
Requires-Dist: motor (==2.4.0) ; extra == 'async-cache'
Requires-Dist: aioredis (==1.3.1) ; extra == 'async-cache'
Provides-Extra: cache
Requires-Dist: boto3 (==1.18.4) ; extra == 'cache'
Requires-Dist: pymongo (==3.12.0) ; extra == 'cache'
Requires-Dist: redis (==3.5.3) ; extra == 'cache'
Provides-Extra: speedups
Requires-Dist: aiodns (>=1.1) ; extra == 'speedups'
Requires-Dist: Brotli (==1.0.9) ; extra == 'speedups'
Requires-Dist: cchardet (==2.1.7) ; extra == 'speedups'

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

<h1 align="center">
  HypixelIO
</h1>

<h3 align="center">
A Modern, Efficient and Easy way of interacting with the Hypixel API!
</h3>

<p align="center">

<a href="https://www.python.org/">
    <img src="http://ForTheBadge.com/images/badges/made-with-python.svg" alt="Made with Python" />
</a>

</p>

<p align="center">

<a href="https://pypi.org/project/HypixelIO">
    <img src="https://img.shields.io/pypi/l/HypixelIO" alt="PYPI - License" />
</a>

<a href="https://pypi.org/project/HypixelIO">
    <img src="https://img.shields.io/pypi/dm/ansicolortags.svg" alt="PYPI Download per Month" />
</a>

<a href="https://pypi.org/project/HypixelIO">
    <img src="https://img.shields.io/pypi/v/HypixelIO" alt="PYPI" />
</a>

<a href="https://pypi.org/project/HypixelIO">
    <img src="https://img.shields.io/pypi/pyversions/HypixelIO" alt="PYPI Python Version" />
</a>

<a href="https://GitHub.com/janaSunrise/HypixelIO/graphs/commit-activity">
    <img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" alt="Maintenance" />
</a>

</p>

<p align="center">

<a href="https://github.com/janaSunrise/HypixelIO">
    <img src="https://img.shields.io/github/languages/code-size/janaSunrise/HypixelIO" alt="Code Size" />
</a>

<a href="https://discord.gg/MKC4qna4Gz">
    <img src="https://discordapp.com/api/guilds/835940276869791816/widget.png?style=shield" alt="Discord" />
</a>

</p>

<h3 align="center">
  <a href="https://hypixelio.readthedocs.org">Docs</a>
  <span> · </span>
  <a href="https://github.com/janaSunrise/HypixelIO/issues">Report a bug</a>
  <span> · </span>
  <a href="https://github.com/janaSunrise/HypixelIO/discussions">Discussions</a>
  <span> · </span>
  <a href="https://discord.gg/MKC4qna4Gz">Discord</a>
</h3>

## ✨ Why choose HypixelIO?

- Modern way of handling requests
- Modern OOP based structure  
- Both Async and general support.
- Simple rate handling, and caching.
- Elegant design with Complete optimization.
- Easy to use with a modern and simple design
- Full API coverage

## 🚀 Installing

**Python 3.7 or above is required!**

**Note**: This library has caching modules downloaded when installed. If you need more
  adapters support, You should refer to the extra requires below.

```sh
# 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
```

To get extra features, Here are the commands for them.

```sh
# Or use [speedups] to speed up only for async features
python3 -m pip install -U "HypixelIO[speedups]"

# Take advantage of caching by installing caching backends
python3 -m pip install -U "HypixelIO[cache]"

# If you need async caching for AsyncClient by installing caching backends
python3 -m pip install -U "HypixelIO[async-cache]"

# Or get all the features!
python3 -m pip install -U "HypixelIO[all]"
```

## Usage

```python
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(name="user's-username")

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

### Async usage

```python
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(name="user's-username")

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

**Find more examples [here](https://github.com/janaSunrise/HypixelIO/tree/main/examples)**

## 📢 Changelog

If you're interested in seeing the **Changelog**, Go [here!](https://github.com/janaSunrise/HypixelIO/blob/main/CHANGELOG.md)

## 🤝 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](https://www.conventionalcommits.org/en/v1.0.0-beta.3/) before
making the commit message. You can find our contributing guidelines [here](https://github.com/janaSunrise/HypixelIO/blob/main/CONTRIBUTING.md)

And, We have a branch called `dev` containing development code. So if you're 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](https://github.com/janaSunrise/HypixelIO/discussions) or join our discord server!

[![Discord](https://discordapp.com/api/guilds/835940276869791816/widget.png?style=shield)](https://discord.gg/MKC4qna4Gz)

## 🙌 Show your support

Be sure to leave a ⭐️ if you like the project!

## ▶ Links

- [Official Documentation](http://hypixelio.rtfd.io/)
- [Raise an Issue](https://github.com/janaSunrise/HypixelIO/issues)
- [Discussions](https://github.com/janaSunrise/HypixelIO/discussions)
- [API Documentation](https://api.hypixel.net)


<div align="center">Made by janaSunrise with ❤</div>


