Metadata-Version: 2.1
Name: pypixel-api
Version: 0.2.1
Summary: An asynchronous wrapper for the Hypixel API.
Home-page: https://github.com/plun1331/PyPixel
Author: plun1331
License: MIT
Project-URL: Documentation, https://pypixel.readthedocs.io/en/latest/
Project-URL: Issue tracker, https://github.com/plun1331/PyPixel/issues
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: aiohttp (~=3.7.3)
Requires-Dist: NBT (~=1.5.0)

# PyPixel

[![Discord Server Invite](https://discord.com/api/guilds/766123673425281025/embed.png)](
https://discord.gg/k6fgvUn3aF)
[![PyPI version info](https://img.shields.io/pypi/v/pypixel-api.svg)](
https://pypi.python.org/pypi/pypixel-api)
[![PyPI supported Python versions](https://img.shields.io/pypi/pyversions/pypixel-api.svg)](
https://pypi.python.org/pypi/pypixel-api)
[![Documentation Status](https://readthedocs.org/projects/pypixel/badge/?version=latest)](
https://pypixel.readthedocs.io/en/latest/)

An asynchronous Python wrapper for the Hypixel API.



# Installation

**Python 3.6 or higher is required**

You can install the package with the following command.

```sh
# Linux/macOS
python3 -m pip install -U pypixel-api

# Windows
py -3 -m pip install -U pypixel-api
```
Or, you can install the development version from the GitHub:

```shell
# Linux/macOS
python3 -m pip install -U git+https://github.com/plun1331/PyPixel

# Windows
py -3 -m pip install -U git+https://github.com/plun1331/PyPixel
```

# Examples
You can find some examples [in our documentation](https://pypixel.readthedocs.io/en/latest/examples.html)

# Changelog
## 0.2.0
- Removed API Key validation.
- Added support for the ``/skyblock/auctions`` endpoint.
- Added ``stripFormatting(text)`` to ``HypixelUtils`` to strip Minecraft text formatting from strings.
- The wrapper now sends an ``Api-Key`` header to authenticate with the API instead of the ``key`` path param.
- The wrapper will also send a ``User-Agent`` header to the APIs that it uses.
- The cache no longer uses Threading.

## 0.1.9
- Added support for the `/resources/achievements` endpoint.
- Added a kwarg to bypass API key validation.
- Added this changelog to the documentation.
- A few other changes that can be found in the docs.

## 0.1.8a
- The module will now return `None` instead of having the value simply be missing.

## 0.1.7
- Added documentation: [pypixel.readthedocs.io](https://pypixel.readthedocs.io/en/latest/)

## 0.1.6
- Add some methods

## 0.1.5
- Released to PyPI

## 0.1.4a
- Added a changelog
- Introduced SkyBlock Profiles
- Added 3 new fuctions to `.Hypixel` (`.get_name(uuid)`, `.get_uuid(name)`, and `.get_profiles(uuid)`)
- Deleted `Other.py` in favor of a submodule, `utils`
- Moved the `send_request()` method to `.Hypixel` and renamed it `_send()`
- Added a new requirement, `NBT` (Used for parsing NBT data).
- Added some exception classes.
- Started subclassing `object` for no paticular reason.






