Merge pull request #19 from kellyjonbrazil/dev

Dev v1.5.3

Author: kellyjonbrazil

.gitignore

@@ -4,3 +4,4 @@ dist/
 build/
 *.egg-info/
 .github/
+.vscode/settings.json

CHANGELOG

@@ -1,5 +1,8 @@
 jtbl changelog
 
+20231022 v1.5.3
+- Add `-f` option for fancy table output
+
 20230522 v1.5.2
 - Fix output for empty array
 

README.md

@@ -55,14 +55,15 @@ $ <JSON Data> | jtbl [OPTIONS]
 ### Options
 - `--cols=n` manually configure the terminal width
 - `-c` CSV table output
+- `-f` fancy table output
+- `-h` help - prints help information
 - `-H` HTML table output
 - `-m` markdown table output
-- `-n` no data wrapping if too long for the terminal width (overrides `--cols` and `-t`)
+- `-n` no-wrap - no data wrapping if too long for the terminal width (overrides `--cols` and `-t`)
 - `-q` quiet - don't print error messages to STDERR
 - `-r` rotate the data (each row turns into a table of key/value pairs)
 - `-t` truncate data instead of wrapping if too long for the terminal width
 - `-v` prints version information
-- `-h` prints help information
 
 ## Compatible JSON Formats
 `jtbl` works best with a shallow array of JSON objects. Each object should have a few elements that will be turned into table columns. Fortunately, this is how many APIs present their data.

jtbl/cli.py

@@ -7,7 +7,7 @@
 import tabulate
 import shutil
 
-__version__ = '1.5.2'
+__version__ = '1.5.3'
 SUCCESS, ERROR = True, False
 
 
@@ -32,14 +32,15 @@ def helptext():
 
                 --cols=n   manually configure the terminal width
                 -c         CSV table output
+                -f         fancy table output
+                -h         help
                 -H         HTML table output
                 -m         markdown table output
-                -n         do not try to wrap if too wide for the terminal
+                -n         no-wrap - do not try to wrap if too wide for the terminal
                 -q         quiet - don't print error messages
                 -r         rotate table output
                 -t         truncate data if too wide for the terminal
                 -v         version info
-                -h         help
     '''))
 
 
@@ -307,6 +308,7 @@ def main():
     csv = 'c' in options
     html = 'H' in options
     markdown = 'm' in options
+    fancy_grid = 'f' in options
     nowrap = 'n' in options
     quiet = 'q' in options
     rotate = 'r' in options
@@ -318,6 +320,8 @@ def main():
         tbl_fmt = 'github'
     elif html:
         tbl_fmt = 'html'
+    elif fancy_grid:
+        tbl_fmt = 'fancy_grid'
     else:
         tbl_fmt = 'simple'
 

man/jtbl.1

@@ -1,4 +1,4 @@
-.TH jtbl 1 2023-02-28 1.5.1 "JTBL - JSON tables in the terminal"
+.TH jtbl 1 2023-10-22 1.5.3 "JTBL - JSON tables in the terminal"
 .SH NAME
 jtbl \- Print JSON and JSON Lines data as a table in the terminal
 .SH SYNOPSIS
@@ -22,11 +22,15 @@ cat data.json | jtbl [OPTIONS]
 
 \fB-c\fP CSV table output
 
+\fB-h\fP help
+
+\fB-f\fP fancy table output
+
 \fB-H\fP HTML table output
 
 \fB-m\fP markdown table output
 
-\fB-n\fP do not try to wrap if too wide for the terminal
+\fB-n\fP no-wrap - do not try to wrap if too wide for the terminal
 
 \fB-q\fP quiet - don't print error messages
 

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name='jtbl',
-    version='1.5.2',
+    version='1.5.3',
     author='Kelly Brazil',
     author_email='[email protected]',
     description='A simple cli tool to print JSON and JSON Lines data as a table in the terminal.',

tests/test_make_table.py

@@ -495,6 +495,24 @@ def test_html(self):
 
         self.assertEqual(jtbl.cli.make_table(data=stdin, columns=self.columns, nowrap=True, table_format='html'), (self.SUCCESS, expected))
 
+    def test_fancy(self):
+        """test fancy output with -f"""
+        stdin = [{"name":"www.cnn.com.","class":"IN","type":"CNAME","ttl":147,"data":"turner-tls.map.fastly.net."},{"name":"turner-tls.map.fastly.net.","class":"IN","type":"A","ttl":5,"data":"151.101.1.67"},{"name":"turner-tls.map.fastly.net.","class":"IN","type":"A","ttl":5,"data":"151.101.65.67"},{"name":"turner-tls.map.fastly.net.","class":"IN","type":"A","ttl":5,"data":"151.101.129.67"},{"name":"turner-tls.map.fastly.net.","class":"IN","type":"A","ttl":5,"data":"151.101.193.67"}]
+        expected = textwrap.dedent('''\
+        ╒════════════════════════════╤═════════╤════════╤═══════╤════════════════════════════╕
+        │ name                       │ class   │ type   │   ttl │ data                       │
+        ╞════════════════════════════╪═════════╪════════╪═══════╪════════════════════════════╡
+        │ www.cnn.com.               │ IN      │ CNAME  │   147 │ turner-tls.map.fastly.net. │
+        ├────────────────────────────┼─────────┼────────┼───────┼────────────────────────────┤
+        │ turner-tls.map.fastly.net. │ IN      │ A      │     5 │ 151.101.1.67               │
+        ├────────────────────────────┼─────────┼────────┼───────┼────────────────────────────┤
+        │ turner-tls.map.fastly.net. │ IN      │ A      │     5 │ 151.101.65.67              │
+        ├────────────────────────────┼─────────┼────────┼───────┼────────────────────────────┤
+        │ turner-tls.map.fastly.net. │ IN      │ A      │     5 │ 151.101.129.67             │
+        ├────────────────────────────┼─────────┼────────┼───────┼────────────────────────────┤
+        │ turner-tls.map.fastly.net. │ IN      │ A      │     5 │ 151.101.193.67             │
+        ╘════════════════════════════╧═════════╧════════╧═══════╧════════════════════════════╛''')
+        self.assertEqual(jtbl.cli.make_table(data=stdin, columns=self.columns, nowrap=True, table_format='fancy_grid'), (self.SUCCESS, expected))
 
     def test_rotate(self):
         """test html output"""