python

This repository has been archived on 2023-06-07. You can view files and clone it, but cannot push or open issues or pull requests.

Go to file

Leon Bowie 485cf85ad0 update dependencies		2021-09-24 22:00:40 +12:00
.github	Bump poetry from 1.1.8 to 1.1.9 in /.github/workflows	2021-09-20 01:17:44 +00:00
aiomcstats	last change	2021-07-15 13:29:35 +12:00
docs	Bump sphinx from 4.1.2 to 4.2.0 in /docs	2021-09-13 01:16:01 +00:00
tests	release 0.1.3	2021-04-08 11:18:51 +12:00
.darglint	format	2020-12-09 18:10:52 +13:00
.flake8	format	2020-12-09 18:10:52 +13:00
.gitignore	format	2020-12-09 18:10:52 +13:00
.pre-commit-config.yaml	format	2020-12-09 18:10:52 +13:00
CODE_OF_CONDUCT.rst	General cleanup	2021-04-07 16:30:57 +12:00
CONTRIBUTING.rst	General cleanup	2021-04-07 16:30:57 +12:00
LICENSE	Create LICENSE	2020-12-08 14:09:52 +13:00
README.md	Update all discord links	2021-08-16 20:21:28 +12:00
codecov.yml	format	2020-12-09 18:10:52 +13:00
mypy.ini	General cleanup	2021-04-07 16:30:57 +12:00
noxfile.py	Base for finished version	2021-04-07 14:45:22 +12:00
poetry.lock	update dependencies	2021-09-24 22:00:40 +12:00
pyproject.toml	Bump flake8-bugbear from 21.4.3 to 21.9.1	2021-09-13 19:48:42 +00:00
readthedocs.yml	format	2020-12-09 18:10:52 +13:00

README.md

Aiomcstats

Get information about minecraft servers.

Asyncpixel is an open source asyncronous python wrapper for the hypixel api with 100% of all endpoints.

🤖 🎨 🚀

Docs · Feature request · Report a bug · Support: Discussions & Discord

✨ Features

Asyncronous. Unlike other libraries Asyncpixel is fully asyncronous. This makes it perfect to use in your next discord bot or powerful website without having to worry about blocking.
100% API coverage. Asyncpixel is currently the only python library with full coverage of the hypixel API meaning that no endpoints are left untouched and outof your reach.
Pydantic models. All models are checked and validated by Pydantic meaning that the data is always in the correct format perfect for you to use.
Available on pypi. Asyncpixel is available on pypi meaning no building from source just use pip install asyncpixel to use it in your project.

🏁 Getting Started with Asyncpixel

To get started check out the documentation which lives here and is generously hosted by readthedocs.

Installation

Use the package manager pip or your favourite tool to install asyncpixel.

pip install asyncpixel

Example

import asyncpixel
import asyncio

async def main():
    hypixel = asyncpixel.Hypixel("hypixel_api_key")
    profile = await hypixel.profile("405dcf08b80f4e23b97d943ad93d14fd")
    print(profile)
    await hypixel.close()


asyncio.run(main())

❗ Code of Conduct

Obsidion-dev is dedicated to providing a welcoming, diverse, and harrassment-free experience for everyone. We expect everyone in the Obsidion-dev community to abide by our Code of Conduct. Please read it.

🙌 Contributing to Asyncpixel

From opening a bug report to creating a pull request: every contribution is appreciated and welcomed. If you're planning to implement a new feature or change the library please create an issue first. This way we can ensure your work is not in vain.

Not Sure Where to Start?

A good place to start contributing, are the Good first issues.

📝 License

Asyncpixel is open-source. The library is licensed GPL v3.

💬 Get in touch

If you have a question or would like to talk with other Asyncpixel users, please hop over to Github discussions or join our Discord server:

Discord chatroom

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_AjayACST
🚧

_Alex
💻 🐛

_{Damian Grzanka}
💻

This project follows the all-contributors specification. Contributions of any kind welcome!