From 1ef5f7a64db6a9c811bd77ebf1d1d909b885d80b Mon Sep 17 00:00:00 2001 From: Andre Basche Date: Sat, 4 Mar 2023 22:38:43 +0100 Subject: [PATCH] Add badges --- README.md | 15 +++++++++++++-- setup.py | 15 ++++++++++++++- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 84ad321..530016d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ **This python package is unofficial and is not related in any way to Haier. It was developed by reversed engineered requests and can stop working at anytime!** # pyhOn +[![PyPI - Status](https://img.shields.io/pypi/status/pyhOn)](https://pypi.org/project/pyhOn) +[![PyPI](https://img.shields.io/pypi/v/pyhOn?color=blue)](https://pypi.org/project/pyhOn) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyhOn)](https://www.python.org/) +[![PyPI - License](https://img.shields.io/pypi/l/pyhOn)](https://github.com/Andre0512/pyhOn/blob/main/LICENCE) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyhOn)](https://pypistats.org/packages/pyhOn) Control your Haier appliances with python! The idea behind this library is, to make the use of all available commands as simple as possible. + +## Installation +```bash +pip install pyhOn +``` + ### Quick overview -To get an idea of what is possible, use the commandline-tool `pyhOn`. This lists all available options of the appliances from your Haier Account. +To get an idea of what is possible, use the commandline-tool `pyhOn`. This command requests all available options of connected appliances from the hOn api of your Haier Account. ```commandline $ pyhOn --user example@mail.com --password pass123 ========== Waschmaschine ========== @@ -67,7 +78,7 @@ async with HonConnection(USER, PASSWORD) as hon: ## Tested devices - Haier Washing Machine HW90 -_Unfortunately I don't have any more haier appliances_ +_Unfortunately I don't have any more Haier appliances..._ ## Usage example This library is used for the custom [HomeAssistant Integration "Haier hOn"](https://github.com/Andre0512/hOn). diff --git a/setup.py b/setup.py index d3fbaa0..6356845 100644 --- a/setup.py +++ b/setup.py @@ -12,13 +12,26 @@ setup( description="Control hOn devices with python", long_description=long_description, long_description_content_type='text/markdown', - url="https://github.com/Andre0512/pyh0n", + project_urls={ + "GitHub": "https://github.com/Andre0512/pyhOn", + "PyPI": "https://pypi.org/project/pyhOn", + }, license="MIT", platforms="any", packages=find_packages(), include_package_data=True, python_requires=">=3.10", install_requires=["aiohttp"], + classifiers=[ + "Development Status :: 3 - Alpha", + "Environment :: Console", + "License :: OSI Approved :: MIT License", + "Natural Language :: English", + "Operating System :: OS Independent", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Topic :: Software Development :: Libraries :: Python Modules", + ], entry_points={ 'console_scripts': [ 'pyhOn = pyhon.__main__:start',