Version 0.4.0 release

Author: maximilionus

CHANGELOG.md

@@ -2,6 +2,18 @@
 This project uses [semantic versioning](https://semver.org/). Note that semver principles for this tool are only reflected on public part of it - `cli`. Code of this project may be changed in any **not backwards compatible** way without `MAJOR` version incrementation.
 
 
+## 0.4.0 : 2022.05.26
+### Added
+- Inbox SMS messages handling with new commands:
+  - `list`
+  - `view`
+  - `count`
+- "Did you mean..." prompt on cli command misspelling
+
+### Changed
+- Enhanced `auth login` visualization
+
+
 ## 0.3.1 : 2022.05.09
 ### Fixed
 - Stated new features from `0.3.0` release in project `README`

README.md

@@ -66,23 +66,10 @@ $ hurocon --help
 Each command and subcommand in this tool has a special `--help` flag to display detailed information about it
 
 ### Authentication
-Foremost, you need to specify the authentication details so that this tool can access the device in the future. You do it in two ways.
-
-- In interactive mode:
-  ``` bash
-  $ hurocon auth login
-  ```
-
-- Manually, by running:
-  ```bash
-  # Initialize local configuration file
-  $ hurocon config init
-
-  # Show path to local configuration file
-  $ hurocon config path
-  ```
-
-  And then manually editing the `json` file with any text editor. It has a human-readable structure, so every part of it is exactly what you think it is.
+Foremost, you need to specify the authentication details so that this tool can access the device.
+``` bash
+$ hurocon auth login
+```
 
 ### Testing Connection
 After auth details successfully specified you can test your connection with router by running

hurocon/cli/auth.py

@@ -1,13 +1,16 @@
 from getpass import getpass
 
 import click
+from click_didyoumean import DYMGroup
 from huawei_lte_api.Client import Client
 
-from .. import core
 from .root import cli
+from ..core.local_cfg import AuthConfig
+from ..core.connection import HRC_Connection
+from ..core.const import LOCAL_CONFIG_DEFAULT
 
 
-@cli.group()
+@cli.group(cls=DYMGroup)
 def auth():
     """ Router authentication """
     pass
@@ -18,18 +21,18 @@ def auth_login():
     """ Safely configure all authentication related details for further interactions """
     print('Authentication Configurator\n')
     con_ip = input(
-        '(leave empty to use "{}")\n'
-        'Full address to router: '
-        .format(core.LOCAL_CONFIG_DEFAULT['connection_address'])
+        '  (leave empty to use "{}")\n'
+        '• Full address to router: '
+        .format(LOCAL_CONFIG_DEFAULT['connection_address'])
     )
-    uname = input('Username: ')
-    passwd = getpass('Password: ')
+    uname = input('• Username: ')
+    passwd = getpass('• Password: ')
 
-    auth_cfg = core.AuthConfig()
+    auth_cfg = AuthConfig()
     auth_cfg.username = uname
     auth_cfg.password = passwd
     auth_cfg.connection_address = con_ip if len(con_ip) > 0 else \
-        core.LOCAL_CONFIG_DEFAULT['connection_address']
+        LOCAL_CONFIG_DEFAULT['connection_address']
 
     auth_cfg.commit()
 
@@ -39,16 +42,16 @@ def auth_login():
 @auth.command('logout')
 def auth_logout():
     """ Remove all authentication details """
-    core.AuthConfig().reset()
-    core.AuthConfig().commit()
+    AuthConfig().reset()
+    AuthConfig().commit()
     print("All authentication details removed")
 
 
 @auth.command('test')
 def auth_test_connection():
     """ Test connection to router with current auth details """
     try:
-        with core.HRC_Connection() as router_con:
+        with HRC_Connection() as router_con:
             Client(router_con)
     except Exception as e:
         msg = 'Auth failed, reason: "{}"'.format(e)

hurocon/cli/config.py

@@ -1,10 +1,12 @@
 import click
+from click_didyoumean import DYMGroup
 
-from .. import core
+from ..core.local_cfg import LocalConfig
+from ..core.const import LOCAL_CONFIG_PATH
 from .root import cli
 
 
-@cli.group()
+@cli.group(cls=DYMGroup)
 def config():
     """ CLI configuration """
 
@@ -17,28 +19,28 @@ def config_init():
     File will only be generated if no configuration file already exists
     on default path.
     """
-    cfg = core.LocalConfig(auto_file_creation=False)
+    cfg = LocalConfig(auto_file_creation=False)
 
     if not cfg.file_exists():
         if cfg.create_file():
             click.echo('Configuration file successfully generated at "{}"'
-                       .format(core.LOCAL_CONFIG_PATH)
+                       .format(LOCAL_CONFIG_PATH)
                        )
         else:
             click.echo('Can not generate configuration file at "{}"'
-                       .format(core.LOCAL_CONFIG_PATH)
+                       .format(LOCAL_CONFIG_PATH)
                        )
     else:
         click.echo('Configuration file already exists on path: "{}"'
-                   .format(core.LOCAL_CONFIG_PATH)
+                   .format(LOCAL_CONFIG_PATH)
                    )
 
 
 @config.command('remove')
 def config_remove():
     """ Erase local configuration """
 
-    if core.LocalConfig.erase_config() is True:
+    if LocalConfig.erase_config() is True:
         click.echo("All local configuration files and dirs successfully erased")
     else:
         click.echo("No local configuration files detected")
@@ -53,13 +55,13 @@ def config_get_path():
     doesn't mean that this file actually exists at the time the command is
     called
     """
-    click.echo(core.LOCAL_CONFIG_PATH)
+    click.echo(LOCAL_CONFIG_PATH)
 
 
 @config.command('exist')
 def config_exist():
     """ Check does the local configuration file exists """
-    if core.LOCAL_CONFIG_PATH.exists() is True:
+    if LOCAL_CONFIG_PATH.exists() is True:
         click.echo("Configuration file do exist")
     else:
         click.echo("Configuration file doesn't exist")

hurocon/cli/device.py

@@ -1,14 +1,15 @@
 from pprint import pformat
 
 import click
+from click_didyoumean import DYMGroup
 from huawei_lte_api.Client import Client
 from huawei_lte_api.enums.device import ControlModeEnum
 
-from .. import core
 from .root import cli
+from ..core.connection import HRC_Connection
 
 
-@cli.group()
+@cli.group(cls=DYMGroup)
 def device():
     """ Device commands """
     pass
@@ -18,7 +19,7 @@ def device():
 def device_info():
     """ Get device information """
     try:
-        with core.HRC_Connection() as conn:
+        with HRC_Connection() as conn:
             client = Client(conn)
             device_info_str = pformat(
                 client.device.information()
@@ -36,7 +37,7 @@ def device_info():
 def device_reboot():
     """ Reboot the router without any confirmation prompts """
     try:
-        with core.HRC_Connection() as conn:
+        with HRC_Connection() as conn:
             Client(conn).device.set_control(ControlModeEnum.REBOOT)
     except Exception as e:
         msg = 'Execution failed, reason: "{}"'.format(e)

hurocon/cli/lte.py

@@ -1,11 +1,12 @@
 import click
+from click_didyoumean import DYMGroup
 from huawei_lte_api.Client import Client
 
-from .. import core
 from .root import cli
+from ..core.connection import HRC_Connection
 
 
-@cli.group()
+@cli.group(cls=DYMGroup)
 def lte():
     """ Cellular connection controls """
     pass
@@ -15,7 +16,7 @@ def lte():
 def lte_status():
     """ Get cellular connection status """
     try:
-        with core.HRC_Connection() as conn:
+        with HRC_Connection() as conn:
             con_stat = Client(conn).dial_up.mobile_dataswitch()['dataswitch']
     except Exception as e:
         msg = 'Execution failed, reason: "{}"'.format(e)
@@ -35,7 +36,7 @@ def lte_set_connection(mode: bool):
     MODE (bool): True, False | [Y]es, [N]o | 1, 0
     """
     try:
-        with core.HRC_Connection() as conn:
+        with HRC_Connection() as conn:
             Client(conn).dial_up.set_mobile_dataswitch(int(mode))
     except Exception as e:
         msg = 'Can not switch connection mode, reason: "{}"'.format(e)

hurocon/cli/models/sms.py

@@ -0,0 +1,39 @@
+from huawei_lte_api.Client import Client
+
+from ...core.connection import HRC_Connection
+
+
+def get_sms_list_deep(page_depth: int = 1) -> dict:
+    """
+    SMS deep scanning function
+
+    :param page_depth: Depth of pages to be fetched and scanned, defaults to 1
+    :return: Dictionary with all messages
+    """
+    messages_all = {
+        'Count': 0,
+        'Messages': {
+            'Pages': [
+                # page_0[[message_0, message_1]], page_1[[...]]...
+            ]
+        }
+    }
+
+    for selected_page in range(1, 2 if page_depth <= 1 else page_depth + 1):
+        with HRC_Connection() as conn:
+            messages_current_page = Client(conn).sms.get_sms_list(
+                page=selected_page
+            )
+
+        if messages_current_page['Count'] == '0':
+            break
+
+        messages_all['Count'] = str(
+            int(messages_all['Count']) + int(messages_current_page['Count'])
+        )
+
+        messages_all['Messages']['Pages'].append(
+            messages_current_page['Messages']['Message']
+        )
+
+    return messages_all

hurocon/cli/root.py

@@ -1,9 +1,10 @@
 import click
+from click_didyoumean import DYMGroup
 
 from .. import meta
 
 
-@click.group()
+@click.group(cls=DYMGroup)
 @click.version_option(meta.version)
 def cli():
     """ Command line interface for Huawei LTE routers """