soco-cli 0.4.80__tar.gz → 0.4.82__tar.gz

{soco_cli-0.4.80/soco_cli.egg-info → soco_cli-0.4.82}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: soco-cli
-Version: 0.4.80
+Version: 0.4.82
 Summary: Sonos command line control utility, based on SoCo
 Author-email: Avantrec Ltd <soco_cli@avantrec.com>
 Project-URL: Homepage, https://github.com/avantrec/soco-cli
@@ -12,7 +12,7 @@ Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: soco==0.27.1; python_version < "3.6"
-Requires-Dist: soco>=0.30.9; python_version >= "3.6"
+Requires-Dist: soco>=0.30.13; python_version >= "3.6"
 Requires-Dist: ifaddr==0.1.7; python_version < "3.7"
 Requires-Dist: ifaddr>=0.2.0; python_version >= "3.7"
 Requires-Dist: tabulate
@@ -20,6 +20,7 @@ Requires-Dist: rangehttpserver
 Requires-Dist: xmltodict
 Requires-Dist: fastapi; python_version >= "3.7"
 Requires-Dist: uvicorn; python_version >= "3.7"
+Dynamic: license-file
 
 
 # SoCo-CLI: Control Sonos from the Command Line

{soco_cli-0.4.80 → soco_cli-0.4.82}/README.md

@@ -202,7 +202,7 @@ This allows the use of shorthand like `sk stop`, to stop playback on the Kitchen
 ### Options for the `sonos` Command
 
 - **`--version, -v`**: Print the versions of SoCo-CLI, SoCo, and Python.
-- **`--check_for_update`**: Check for a more recent version of SoCo-CLI.
+- **`--check-for-update`**: Check for a more recent version of SoCo-CLI.
 - **`--actions`**: Print the list of available actions.
 - **`--docs`**: Print the URL of this README documentation, for the version of SoCo-CLI being used.
 - **`--log <level>`**: Turn on logging. Available levels are `NONE` (default), `CRITICAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, in order of increasing verbosity. `INFO` level logging tends to be the most useful when troubleshooting SoCo-CLI issues.
@@ -211,13 +211,13 @@ The following options are for use with the cached discovery mechanism:
 
 - **`--use-local-speaker-list, -l`**: Use the local speaker list instead of SoCo discovery. The speaker list will first be created and saved if it doesn't already exist.
 - **`--refresh-local-speaker-list, -r`**: In conjunction with the `-l` option, the speaker list will be regenerated and saved.
-- **`--network_discovery_threads, -t`**: The maximum number of parallel threads used to scan the local network.
-- **`--network_discovery_timeout, -n`**: The timeout used when scanning each host on the local network (how long to wait for a socket connection on port 1400 before giving up).
-- **`--min_netmask, -m`**: The minimum netmask to use when scanning networks. Used to constrain the IP search space.
+- **`--network-discovery-threads, -t`**: The maximum number of parallel threads used to scan the local network.
+- **`--network-discovery-timeout, -n`**: The timeout used when scanning each host on the local network (how long to wait for a socket connection on port 1400 before giving up).
+- **`--min-netmask, -m`**: The minimum netmask to use when scanning networks. Used to constrain the IP search space.
 
 Note that the `sonos-discover` utility (discussed below) can also be used to manage the local speaker list. This is the recommended way of using cached discovery: first run `sonos-discover` to create the local speaker database, then use `sonos` with the `-l` option to use the local database when invoking `sonos` actions.
 
-If you set the environment variable **`USE_LOCAL_CACHE=TRUE`**, the `--use_local_speaker_list` option will always be used.
+If you set the environment variable **`USE_LOCAL_CACHE=TRUE`**, the `--use-local-speaker-list` option will always be used.
 
 ### Firewall Rules
 
@@ -766,7 +766,8 @@ This is SoCo-CLI interactive mode. Interactive commands are as follows:
     'cd'         :  Change the working directory of the shell, e.g. 'cd ..'.
                     Note that on Windows, backslashes must be doubled, e.g.:
                     'cd C:\\'
-    'check_for_update' : Check whether an update is available
+    'check-for-update' 
+                 : Check whether an update is available
     'docs'       :  Print a link to the online documentation.
     'exec'       :  Run a shell command, e.g.: 'exec ls -l'.
     'exit'       :  Exit the shell.
@@ -877,12 +878,12 @@ Positional arguments can be used multiple times within an action (unlikely to be
 #### Saving and Loading Aliases
 
 ```
-sonos --save_aliases <filename>
-sonos --load_aliases <filename>
-sonos --overwrite_aliases <filename>
+sonos --save-aliases <filename>
+sonos --load-aliases <filename>
+sonos --overwrite-aliases <filename>
 ```
 
-Aliases can be exported to, and loaded from, plain text files using the command line options above. The command will terminate once the file operation is complete. Option `save_aliases` will export the current aliases to the supplied filename; `load_aliases` will load a list of aliases and merge them with the current list (overwriting any duplicate alias names); `overwrite_aliases` will overwrite all current aliases with the list from the file.
+Aliases can be exported to, and loaded from, plain text files using the command line options above. The command will terminate once the file operation is complete. Option `save-aliases` will export the current aliases to the supplied filename; `load-aliases` will load a list of aliases and merge them with the current list (overwriting any duplicate alias names); `overwrite-aliases` will overwrite all current aliases with the list from the file.
 
 The alias file format consists of lines containing `<alias_name> = <alias actions>`, e.g:
 
@@ -939,8 +940,8 @@ If your speakers change in some way (e.g., they are renamed, are assigned differ
 
 The following flags can be used to adjust network discovery behaviour if the discovery process is failing:
 
-- **`--network_discovery_threads, -t`**: The number of parallel threads used to scan the local network.
-- **`--network_discovery_timeout, -n`**: The timeout used when scanning each host on the local network (how long to wait for a socket connection on port 1400 before giving up).
+- **`--network-discovery-threads, -t`**: The number of parallel threads used to scan the local network.
+- **`--network-discovery-timeout, -n`**: The timeout used when scanning each host on the local network (how long to wait for a socket connection on port 1400 before giving up).
 
 These options only have an effect when combined with the `-l` **and** `-r` options.
 
@@ -962,14 +963,14 @@ Discovery works by interrogating all network adapters on the device running SoCo
 
 - **`--print, -p`**: Print the the current contents of the speaker cache file
 - **`--delete-local-speaker-cache, -d`**: Delete the local speaker cache file.
-- **`--network_discovery_threads, -t`**: The maximum number of parallel threads used to scan the local network.
-- **`--network_discovery_timeout, -n`**: The timeout used when scanning each host on the local network (how long to wait for a socket connection on port 1400 before giving up). Use this if `sonos-discover` is not finding all of your Sonos devices.
-- **`--min_netmask, -m`**: The minimum netmask to use when scanning networks. Used to constrain the IP search space. (Note that this option will never **increase** the search space, e.g., if one of the attached networks is 192.168.0.0/24, supplying a `--min_netmask` value of 16 will not increase the search space to 192.168.0.0/16.)
+- **`--network-discovery-threads, -t`**: The maximum number of parallel threads used to scan the local network.
+- **`--network-discovery-timeout, -n`**: The timeout used when scanning each host on the local network (how long to wait for a socket connection on port 1400 before giving up). Use this if `sonos-discover` is not finding all of your Sonos devices.
+- **`--min-netmask, -m`**: The minimum netmask to use when scanning networks. Used to constrain the IP search space. (Note that this option will never **increase** the search space, e.g., if one of the attached networks is 192.168.0.0/24, supplying a `--min-netmask` value of 16 will not increase the search space to 192.168.0.0/16.)
 - **`--version, -v`**: Print the versions of SoCo-CLI, SoCo, Python, and exit.
-- **`--check_for_update`**: Check for a more recent version of SoCo-CLI.  
+- **`--check-for-update`**: Check for a more recent version of SoCo-CLI.  
 - **`--docs`**: Print the URL of this README documentation, for the version of SoCo-CLI being used.
 - **`--log <level>`**: Turn on logging. Available levels are NONE (default), CRITICAL, ERROR, WARN, INFO, DEBUG, in order of increasing verbosity.
-- **`--subnets <subnets_list>`**: Specify which subnet(s) to search, as a comma separated list (without spaces). E.g.: `--subnets 192.168.0.0/24,192.168.1.0/24` or `--subnets 192.168.0.30`. When this option is used, only the specified subnet(s) will be searched, and the `--min_netmask` option (if supplied) is ignored.
+- **`--subnets <subnets_list>`**: Specify which subnet(s) to search, as a comma separated list (without spaces). E.g.: `--subnets 192.168.0.0/24,192.168.1.0/24` or `--subnets 192.168.0.30`. When this option is used, only the specified subnet(s) will be searched, and the `--min-netmask` option (if supplied) is ignored.
 
 ## The SoCo-CLI HTTP API Server
 

{soco_cli-0.4.80 → soco_cli-0.4.82}/requirements.txt

@@ -1,5 +1,5 @@
 soco == 0.27.1; python_version < "3.6"
-soco >= 0.30.9; python_version >= "3.6"
+soco >= 0.30.13; python_version >= "3.6"
 ifaddr == 0.1.7; python_version < "3.7"
 ifaddr >= 0.2.0; python_version >= "3.7"
 tabulate

{soco_cli-0.4.80 → soco_cli-0.4.82}/soco_cli/__init__.py

@@ -10,4 +10,4 @@ server, to control Sonos via HTTP requests.
 For more information, please see: https://github.com/avantrec/soco-cli
 """
 
-__version__ = "0.4.80"
+__version__ = "0.4.82"

{soco_cli-0.4.80 → soco_cli-0.4.82}/soco_cli/api.py

@@ -29,7 +29,8 @@ def run_command(
     speaker_name: Union[str, SoCo],
     action: str,
     *args: str,  # Means that all args are strings
-    use_local_speaker_list: bool = False
+    use_local_speaker_list: bool = False,
+    redirect_io: bool = True,
 ) -> Tuple[int, str, str]:
     """Use SoCo-CLI to run a sonos command.
 
@@ -43,24 +44,30 @@ def run_command(
     Args:
         speaker_name (str or SoCo): The name of the speaker, or its IP address.
             Alternatively, a 'SoCo' object can be supplied.
-        action (str): The The name of the SoCo-CLI action to perform.
+        action (str): The name of the SoCo-CLI action to perform.
         *args (list[str]): The set of arguments that accompany the action.
         use_local_speaker_list (bool, optional): Whether to use the local
             speaker cache.
+        redirect_io (bool, optional): Whether to redirect stdout and stderr
+            to capture their output for inclusion in the return value. If
+            False, messages will be emitted directly to stdout & stderr
+            during execution of the command, and this content will not be
+            included in the return tuple.
 
     Returns:
         (int, str, str): a three-tuple of exit_code, output_string and
-        error_msg.
+        error_msg. If redirect_io is false, output_string will be empty.
     """
 
     # Prevent errors from causing exit
     set_api()
 
-    # Capture stdout and stderr for the duration of this command
-    output = StringIO()
-    sys.stdout = output
-    error = StringIO()
-    sys.stderr = error
+    if redirect_io:
+        # Capture stdout and stderr for the duration of this command
+        output = StringIO()
+        sys.stdout = output
+        error = StringIO()
+        sys.stderr = error
 
     speaker = None
     exception_error = None
@@ -88,8 +95,12 @@ def run_command(
             logging.info("Exception: {}".format(e))
             exception_error = e
 
-        output_msg = output.getvalue().rstrip()
-        error_out = error.getvalue().rstrip()
+        if redirect_io:
+            output_msg = output.getvalue().rstrip()
+            error_out = error.getvalue().rstrip()
+        else:
+            output_msg = ""
+            error_out = ""
 
         if output_msg != "":
             lines = output_msg.splitlines()
@@ -118,9 +129,10 @@ def run_command(
             "Speaker '{}' not found: {}".format(speaker_name, exception_error),
         )
 
-    # Restore stdout and stderr
-    sys.stdout = sys.__stdout__
-    sys.stderr = sys.__stderr__
+    if redirect_io:
+        # Restore stdout and stderr
+        sys.stdout = sys.__stdout__
+        sys.stderr = sys.__stderr__
 
     logging.info("Return value: {}".format(return_tuple))
 

{soco_cli-0.4.80 → soco_cli-0.4.82}/soco_cli/interactive.py

@@ -264,7 +264,7 @@ def interactive_loop(
                     docs()
                     continue
 
-                if command_lower in ["check_for_update"]:
+                if command_lower in ["check-for-update"]:
                     print_update_status()
                     continue
 
@@ -526,7 +526,7 @@ SHELL_COMMANDS = [
     "actions",
     "alias ",
     "cd",
-    "check_for_update",
+    "check-for-update",
     "docs",
     "exec",
     "exit",
@@ -575,8 +575,7 @@ def _set_actions_and_commands_list(use_local_speaker_list=False):
                 include_loop_actions=True,
                 include_wait_actions=True,
                 include_track_follow_actions=True,
-            )
-            + _get_speaker_names(use_local_speaker_list=use_local_speaker_list)
+            ) + _get_speaker_names(use_local_speaker_list=use_local_speaker_list)
         ]
         + SHELL_COMMANDS
         + am.alias_names()
@@ -609,7 +608,8 @@ This is SoCo-CLI interactive mode. Interactive commands are as follows:
     'cd'         :  Change the working directory of the shell, e.g. 'cd ..'.
                     Note that on Windows, backslashes must be doubled, e.g.:
                     'cd C:\\'
-    'check_for_update' : Check whether an update is available
+    'check-for-update'
+                 : Check whether an update is available
     'docs'       :  Print a link to the online documentation.
     'exec'       :  Run a shell command, e.g.: 'exec ls -l'.
     'exit'       :  Exit the shell.

{soco_cli-0.4.80 → soco_cli-0.4.82}/soco_cli/play_local_file_lists.py

@@ -141,7 +141,7 @@ def play_m3u_file(speaker: SoCo, m3u_file: str, options: str = "") -> bool:
     directory, _ = path.split(m3u_file)
     if directory != "":
         chdir(directory)
-    tracks = [str(Path(track.path).absolute()) for track in track_list]  # type:ignore
+    tracks = [str(Path(track.path).absolute()) for track in track_list]  # type: ignore
     logging.info("Files to to play: {}".format(tracks))
 
     play_file_list(speaker, tracks, options)

{soco_cli-0.4.80 → soco_cli-0.4.82}/soco_cli/sonos.py

@@ -105,11 +105,13 @@ def main():
     )
     parser.add_argument(
         "--save_aliases",
+        "--save-aliases",
         type=str,
         help="Save the current shell aliases to the supplied filename and exit",
     )
     parser.add_argument(
         "--load_aliases",
+        "--load-aliases",
         type=str,
         help=(
             "Load shell aliases from the supplied filename and exit (aliases are"
@@ -118,6 +120,7 @@ def main():
     )
     parser.add_argument(
         "--overwrite_aliases",
+        "--overwrite-aliases",
         type=str,
         help=(
             "Overwrite current shell aliases with those from the supplied filename and"

{soco_cli-0.4.80 → soco_cli-0.4.82}/soco_cli/utils.py

@@ -658,6 +658,7 @@ def configure_common_args(parser):
     )
     parser.add_argument(
         "--min_netmask",
+        "--min-netmask",
         "-m",
         type=int,
         default=24,
@@ -693,6 +694,7 @@ def configure_common_args(parser):
     )
     parser.add_argument(
         "--check_for_update",
+        "--check-for-update",
         action="store_true",
         default=False,
         help="Check for a more recent version of SoCo-CLI",

{soco_cli-0.4.80 → soco_cli-0.4.82/soco_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: soco-cli
-Version: 0.4.80
+Version: 0.4.82
 Summary: Sonos command line control utility, based on SoCo
 Author-email: Avantrec Ltd <soco_cli@avantrec.com>
 Project-URL: Homepage, https://github.com/avantrec/soco-cli
@@ -12,7 +12,7 @@ Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: soco==0.27.1; python_version < "3.6"
-Requires-Dist: soco>=0.30.9; python_version >= "3.6"
+Requires-Dist: soco>=0.30.13; python_version >= "3.6"
 Requires-Dist: ifaddr==0.1.7; python_version < "3.7"
 Requires-Dist: ifaddr>=0.2.0; python_version >= "3.7"
 Requires-Dist: tabulate
@@ -20,6 +20,7 @@ Requires-Dist: rangehttpserver
 Requires-Dist: xmltodict
 Requires-Dist: fastapi; python_version >= "3.7"
 Requires-Dist: uvicorn; python_version >= "3.7"
+Dynamic: license-file
 
 
 # SoCo-CLI: Control Sonos from the Command Line

{soco_cli-0.4.80 → soco_cli-0.4.82}/soco_cli.egg-info/requires.txt

@@ -9,7 +9,7 @@ soco==0.27.1
 ifaddr==0.1.7
 
 [:python_version >= "3.6"]
-soco>=0.30.9
+soco>=0.30.13
 
 [:python_version >= "3.7"]
 ifaddr>=0.2.0