Add CLI tool for device discovery (#3)

* Add CLI tool for device discover

* Add new requirement click

* Add changelog entry

* Fix typo

* Add new details about the CLI tool

Author: fabaff

CHANGELOG.rst

@@ -4,10 +4,10 @@ Changelog
 0.3.0 (--)
 ----------
 
-- Support for Shades/Blinds (@retoo)
-- Access to more parts of the Dingz API
-  (Blind Config, System Config and others) (@retoo)
-- Automatic discovery for Dingz units in the local network (@retoo)
+- Add CLI tool
+- Support for shades/blinds (@retoo)
+- Access to more parts of the dingz API (blind config, system config and others) (@retoo)
+- Automatic discovery for dingz units in the local network (@retoo)
 
 0.2.0 (2020-05-20)
 ------------------

README.rst

@@ -35,7 +35,7 @@ You need to have `Python 3 <https://www.python.org>`_ installed.
 - Devices connected to your network
 
 You need to know the IP address of the devices. Please consult your router
-documentation to get this information.
+documentation to get this information or use the `dingz` CLI tool.
 
 Installation
 ------------
@@ -46,10 +46,22 @@ The package is available in the `Python Package Index <https://pypi.python.org/>
 
     $ pip install dingz
 
-Usage
------
+Module usage
+------------
+
+Every unit has its own web interface: `http://IP_ADDRESS <http://IP_ADDRESS>`_ .
+
+See `example.py` for detail about module.
+
+CLI usage
+---------
+
+The package contains a command-line tool which support some basic tasks.
+
+.. code:: bash
+
+   $ dingz discover
 
-Every unit has its own web interface: `http://IP_ADDRESS <http://IP_ADDRESS>`_
 
 License
 -------

dingz/cli.py

@@ -0,0 +1,43 @@
+"""Command-line interface to interact with dingz devices."""
+import click
+from .discovery import discover_dingz_devices
+import asyncio
+
+
+import asyncio
+from functools import wraps
+
+
+def coro(f):
+    """Allow to use async in click."""
+
+    @wraps(f)
+    def wrapper(*args, **kwargs):
+        """Async wrapper."""
+        return asyncio.run(f(*args, **kwargs))
+
+    return wrapper
+
+
+@click.group()
+@click.version_option()
+def main():
+    """Simple command-line tool to interact with dingz devices."""
+
+
+@main.command("discover")
+@coro
+async def discover():
+    """Read the current configuration of a myStrom device."""
+    click.echo("Waiting for UDP broadcast packages...")
+    devices = await discover_dingz_devices()
+
+    print(f"Found {len(devices)} devices")
+    for device in devices:
+        print(
+            f"  MAC address: {device.mac}, IP address: {device.host}, HW: {device.hardware}"
+        )
+
+
+if __name__ == "__main__":
+    main()

setup.py

@@ -23,10 +23,11 @@
     author="Fabian Affolter",
     author_email="fabian@affolter-engineering.ch",
     license="Apache License 2.0",
-    install_requires=["aiohttp<4", "async_timeout<4"],
+    install_requires=["aiohttp<4", "async_timeout<4", "click"],
     packages=find_packages(),
     zip_safe=True,
     include_package_data=True,
+    entry_points={"console_scripts": ["dingz = dingz.cli:main"]},
     classifiers=[
         "Development Status :: 3 - Alpha",
         "Environment :: Console",