v1.4.6

docs/conf.py

@@ -83,7 +83,7 @@
 latex_documents = [
     (
         master_doc,
-        "yamcs-cli.tex",
+        f"yamcs-cli-{release}.tex",
         "Yamcs Command-Line Interface",
         "Space Applications Services",
         "manual",
@@ -101,7 +101,7 @@
     (
         "yamcs_alarms",
         "yamcs-alarms",
-        "Read alarms",
+        "Manage alarms",
         author,
         1,
     ),

docs/yamcs_alarms.rst

@@ -10,21 +10,21 @@ Synopsis
 
     | **yamcs alarms** list [--processor <*PROCESSOR*>]
     | **yamcs alarms** acknowledge [--processor <*PROCESSOR*>]
-       [-c <*COMMENT*>, --comment <*COMMENT*>] <*ALARM*> <*SEQNO*>
+    |    [-c <*COMMENT*>, --comment <*COMMENT*>] <*ALARM*> <*SEQNO*>
     | **yamcs alarms** shelve [--processor <*PROCESSOR*>]
-       [-c <*COMMENT*>, --comment <*COMMENT*>] <*ALARM*> <*SEQNO*>
+    |   [-c <*COMMENT*>, --comment <*COMMENT*>] <*ALARM*> <*SEQNO*>
     | **yamcs alarms** unshelve [--processor <*PROCESSOR*>]
-       [-c <*COMMENT*>, --comment <*COMMENT*>] <*ALARM*> <*SEQNO*>
+    |   [-c <*COMMENT*>, --comment <*COMMENT*>] <*ALARM*> <*SEQNO*>
     | **yamcs alarms** clear [--processor <*PROCESSOR*>]
-       [-c <*COMMENT*>, --comment <*COMMENT*>] <*ALARM*> <*SEQNO*>
+    |   [-c <*COMMENT*>, --comment <*COMMENT*>] <*ALARM*> <*SEQNO*>
     | **yamcs alarms** log [-n <*LINES*>, --lines <*LINES*>]
-       [-s <*DATE*>, --since <*DATE*>] [-u <*DATE*>, --until <*DATE*>]
+    |   [-s <*DATE*>, --since <*DATE*>] [-u <*DATE*>, --until <*DATE*>]
 
 
 Description
 -----------
 
-Read alarms.
+Manage alarms.
 
 
 Commands

docs/yamcs_commands.rst

@@ -11,11 +11,11 @@ Synopsis
     | **yamcs commands** list
     | **yamcs commands** describe <*COMMAND*>
     | **yamcs commands** run [--processor <*PROCESSOR*>] [--dry-run]
-       [--sequence-number <*SEQNO*>] [--arg-file <*FILE*>]
-       [--arg <*KEY=VALUE*> [<*KEY=VALUE*> ...]]
-       <*COMMAND*>
+    |   [--sequence-number <*SEQNO*>] [--arg-file <*FILE*>]
+    |   [--arg <*KEY=VALUE*> [<*KEY=VALUE*> ...]]
+    |   <*COMMAND*>
     | **yamcs commands** log [-n <*LINES*>, --lines <*LINES*>]
-       [-s <*DATE*>, --since <*DATE*>] [-u <*DATE*>, --until <*DATE*>]
+    |   [-s <*DATE*>, --since <*DATE*>] [-u <*DATE*>, --until <*DATE*>]
 
 Description
 -----------

docs/yamcs_events.rst

@@ -9,10 +9,10 @@ Synopsis
 .. rst-class:: synopsis
 
     | **yamcs events** create [-m <*MESSAGE*>, --message <*MESSAGE*>] [--date <*DATE*>]
-       [--sequence-number <*SEQNO*>] [--severity <*LEVEL*>] [--source <*SOURCE*>]
-       [--type <*TYPE*>] [--extra <*KEY=VALUE*> [<*KEY=VALUE*> ...]]
+    |   [--sequence-number <*SEQNO*>] [--severity <*LEVEL*>] [--source <*SOURCE*>]
+    |   [--type <*TYPE*>] [--extra <*KEY=VALUE*> [<*KEY=VALUE*> ...]]
     | **yamcs events** log [-n <*LINES*>, --lines <*LINES*>]
-       [-s <*DATE*>, --since <*DATE*>] [-u <*DATE*>, --until <*DATE*>]
+    |   [-s <*DATE*>, --since <*DATE*>] [-u <*DATE*>, --until <*DATE*>]
 
 Description
 -----------

docs/yamcs_packets.rst

@@ -9,8 +9,8 @@ Synopsis
 .. rst-class:: synopsis
 
     | **yamcs packets** log [-p <*PACKET*>, --packet <*PACKET*>]
-       [-n <*LINES*>, --lines <*LINES*>] [-s <*DATE*>, --since <*DATE*>]
-       [-u <*DATE*>, --until <*DATE*>]
+    |   [-n <*LINES*>, --lines <*LINES*>] [-s <*DATE*>, --since <*DATE*>]
+    |   [-u <*DATE*>, --until <*DATE*>]
 
 Description
 -----------

docs/yamcs_tables.rst

@@ -10,10 +10,12 @@ Synopsis
 
     | **yamcs tables** list
     | **yamcs tables** describe <*TABLE*>
-    | **yamcs tables** dump [-d <*DIR*>, --dir <*DIR*>] [--gzip] <*TABLE*>...
+    | **yamcs tables** dump [-d <*DIR*>, --dir <*DIR*>] [--gzip]
+    |   [-q <*QUERY*>, --query <*QUERY*> ] [--query-file <*FILE*>]
+    |   <*TABLE*>...
     | **yamcs tables** load [-d <*DIR*>, --dir <*DIR*>] [--gzip] <*TABLE*>...
     | **yamcs tables** rebuild-histogram [-s <*DATE*>, --since <*DATE*>]
-       [-u <*DATE*>, --until <*DATE*>] <*TABLE*>...
+    |   [-u <*DATE*>, --until <*DATE*>] <*TABLE*>...
 
 
 Description
@@ -33,7 +35,7 @@ Commands
 
     Describe a table
 
-.. describe:: dump [-d <DIR>, --dir <DIR>] [--gzip] <TABLE>...
+.. describe:: dump [-d <DIR>, --dir <DIR>] [-q <QUERY>, --query <QUERY>] [--query-file FILE] [--gzip] <TABLE>...
 
     Dump table data
 
@@ -59,6 +61,14 @@ Options
 
     With ``load``, decompress the dump.
 
+.. option:: -q <QUERY>, --query <QUERY>
+
+    With ``dump``, provide a SQL WHERE search condition to limit the rows included in the output.
+
+.. option:: --query-file <FILE>
+
+    With ``dump``, specify the path to a file containing a SQL WHERE search condition to limit the rows included in the output.
+
 .. option:: -s <DATE>, --since <DATE>
 
     With ``rebuild-histogram``, include records not older than the specified date.

setup.py

@@ -7,7 +7,7 @@
 
 setuptools.setup(
     name="yamcs-cli",
-    version="1.4.5",
+    version="1.4.6",
     description="Yamcs Command-Line Tools",
     long_description=readme,
     long_description_content_type="text/markdown",
@@ -32,10 +32,11 @@
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Operating System :: OS Independent",
     ],
     platforms="Posix; MacOS X; Windows",
-    install_requires=["argcomplete", "python-dateutil", "yamcs-client>=1.7.0"],
+    install_requires=["argcomplete", "python-dateutil", "yamcs-client>=1.9.0"],
     extras_require={"kerberos": ["yamcs-client-kerberos>=1.2.0"]},
     include_package_data=True,
     zip_safe=False,

src/yamcs/cli/alarms.py

@@ -1,4 +1,3 @@
-import binascii
 from itertools import islice
 
 from yamcs.client import YamcsClient
@@ -9,7 +8,7 @@
 
 class AlarmsCommand(utils.Command):
     def __init__(self, parent):
-        super(AlarmsCommand, self).__init__(parent, "alarms", "Read alarms")
+        super(AlarmsCommand, self).__init__(parent, "alarms", "Manage alarms")
 
         subparsers = self.parser.add_subparsers(title="Commands", metavar="COMMAND")
         subparsers.required = True
@@ -23,7 +22,7 @@ def __init__(self, parent):
 
         # acknowledge
         subparser = self.create_subparser(
-            subparsers, "acknowledge", "Acknowledge an alarms"
+            subparsers, "acknowledge", "Acknowledge an alarm"
         )
         subparser.add_argument(
             "alarm", metavar="ALARM", type=str, help="name of the alarm"

src/yamcs/cli/utils.py

@@ -165,6 +165,7 @@ def parse_ys_url(url):
     else:
         return parts[0], None
 
+
 class Command(object):
     config_options = ["core.url", "core.instance", "core.enable_utc"]