Add parse-trx as an installed script, needed to massage file_parser.p…

…y's main function to do this

README.md

@@ -27,9 +27,14 @@ In the repository source there are a couple example TraceX traces which can be u
 
 ### As a command line utility
 [documentation](https://tracex-parser.readthedocs.io/en/latest/cli-interface.html)
-The `file_parser` module can also be run as a script, which will provide simple statistics on the trace as well as dumping all the events in the trace:
+The `file_parser` module can also be run as a script, which will provide simple statistics on the trace as well as dumping all the events in the trace.
+It can be run by either:
+- Running the module manually: `python3 -m tracex_parser.file_parser`
+- Using the newly installed command: `parse-trx`
+
+Both run methods are identical.
 ```console
-$ python3 -m tracex_parser.file_parser -vvv ./demo_threadx.trx
+$ parse-trx -vvv ./demo_threadx.trx
 Parsing ./demo_threadx.trx
 total events: 974
 object registry size: 16

pyproject.toml

@@ -13,6 +13,9 @@ include = [
     '*.trx',
 ]
 
+[tool.poetry.scripts]
+parse-trx = "tracex_parser.file_parser:main"
+
 [tool.poetry.dependencies]
 python = "^3.6"
 

tracex_parser/file_parser.py

@@ -188,6 +188,28 @@ def parse_tracex_buffer(filepath: str, custom_events_map: Optional[Dict[int, Tra
 
 
 def main():
+    args = parser.parse_args()
+
+    from signal import signal, SIGPIPE, SIG_DFL
+    # Don't break when piping output
+    signal(SIGPIPE, SIG_DFL)
+
+    # set up colours
+    # Truth table for what we want.
+    # Precedence is: color, nocolor, tty
+    # tty | nocolor | color | output
+    # ==============================
+    #  0  |    0    |   0   |   0
+    #  0  |    0    |   1   |   1
+    #  0  |    1    |   0   |   1
+    #  0  |    1    |   1   |   1
+    #  1  |    0    |   0   |   1
+    #  1  |    0    |   1   |   1
+    #  1  |    1    |   0   |   0
+    #  1  |    1    |   1   |   1
+    have_colours = (sys.stdout.isatty() and not args.nocolor) or args.color
+    colour = TextColour(have_colours)
+
     for input_filepath in args.input_trxs:
         print(f'Parsing {input_filepath}')
         tracex_events, obj_reg_map = parse_tracex_buffer(input_filepath)
@@ -218,26 +240,4 @@ def main():
 
 
 if __name__ == '__main__':
-    args = parser.parse_args()
-
-    from signal import signal, SIGPIPE, SIG_DFL
-
-    # Don't break when piping output
-    signal(SIGPIPE, SIG_DFL)
-
-    # set up colours
-    # Truth table for what we want.
-    # Precedence is: color, nocolor, tty
-    # tty | nocolor | color | output
-    # ==============================
-    #  0  |    0    |   0   |   0
-    #  0  |    0    |   1   |   1
-    #  0  |    1    |   0   |   1
-    #  0  |    1    |   1   |   1
-    #  1  |    0    |   0   |   1
-    #  1  |    0    |   1   |   1
-    #  1  |    1    |   0   |   0
-    #  1  |    1    |   1   |   1
-    have_colours = (sys.stdout.isatty() and not args.nocolor) or args.color
-    colour = TextColour(have_colours)
     main()