Add github flavored markdown support.

jrouly · jrouly · commit 95aaa4f16525 · 2018-09-14T12:04:24.000-04:00
diff --git a/README.rst b/README.rst
@@ -150,6 +150,7 @@ Supported table formats are:
 
 - "plain"
 - "simple"
+- "github"
 - "grid"
 - "fancy_grid"
 - "pipe"
@@ -188,6 +189,17 @@ extensions`_::
     eggs      451
     bacon       0
 
+``github`` follows the conventions of `Github flavored Markdown`.  It
+corresponds to the ``pipe`` format without alignment colons::
+
+    >>> print(tabulate(table, headers, tablefmt="github"))
+    | item   | qty   |
+    |--------|-------|
+    | spam   | 42    |
+    | eggs   | 451   |
+    | bacon  | 0     |
+
+
 ``grid`` is like tables formatted by Emacs' `table.el`_
 package.  It corresponds to ``grid_tables`` in Pandoc Markdown
 extensions::
@@ -527,6 +539,16 @@ a multiline cell, and headers with a multiline cell::
     more       42
     spam
 
+``github`` tables::
+
+    >>> print(tabulate(table, headers, tablefmt="github"))
+    | item   | qty   |
+    | name   |       |
+    |--------|-------|
+    | eggs   | 451   |
+    | more   | 42    |
+    | spam   |       |
+
 ``grid`` tables::
 
     >>> print(tabulate(table, headers, tablefmt="grid"))
@@ -638,8 +660,8 @@ Usage of the command line utility
     -s REGEXP, --sep REGEXP   use a custom column separator (default: whitespace)
     -F FPFMT, --float FPFMT   floating point number format (default: g)
     -f FMT, --format FMT      set output table format; supported formats:
-                              plain, simple, grid, fancy_grid, pipe, orgtbl,
-                              rst, mediawiki, html, latex, latex_raw,
+                              plain, simple, github, grid, fancy_grid, pipe,
+                              orgtbl, rst, mediawiki, html, latex, latex_raw,
                               latex_booktabs, tsv
                               (default: simple)
 
diff --git a/tabulate.py b/tabulate.py
@@ -253,6 +253,15 @@ def escape_empty(val):
                               headerrow=DataRow("│", "│", "│"),
                               datarow=DataRow("│", "│", "│"),
                               padding=1, with_header_hide=None),
+                  "github":
+                  TableFormat(lineabove=Line("|", "-", "|", "|"),
+                              linebelowheader=Line("|", "-", "|", "|"),
+                              linebetweenrows=None,
+                              linebelow=None,
+                              headerrow=DataRow("|", "|", "|"),
+                              datarow=DataRow("|", "|", "|"),
+                              padding=1,
+                              with_header_hide=["lineabove"]),
                   "pipe":
                   TableFormat(lineabove=_pipe_line_with_colons,
                               linebelowheader=_pipe_line_with_colons,
diff --git a/test/test_output.py b/test/test_output.py
@@ -191,6 +191,16 @@ def test_simple_multiline_with_empty_cells_headerless():
     assert_equal(expected, result)
 
 
+def test_github():
+    "Output: github with headers"
+    expected = '\n'.join(['| strings   |   numbers |',
+                          '|-----------|-----------|',
+                          '| spam      |   41.9999 |',
+                          '| eggs      |  451      |',])
+    result = tabulate(_test_table, _test_table_headers, tablefmt="github")
+    assert_equal(expected, result)
+
+
 def test_grid():
     "Output: grid with headers"
     expected = '\n'.join(['+-----------+-----------+',
