Add badges
This commit is contained in:
parent
326b5edcff
commit
1ef5f7a64d
2 changed files with 27 additions and 3 deletions
15
README.md
15
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).
|
||||
|
|
15
setup.py
15
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',
|
||||
|
|
Loading…
Reference in a new issue