.github/workflows/ci.yml

@@ -3,14 +3,14 @@ name: CI
 on:
   push:
     paths-ignore:
-      - '.gitignore'
-      - '.readthedocs.yaml'
-      - 'README.rst'
+      - ".gitignore"
+      - ".readthedocs.yaml"
+      - "README.rst"
   pull_request:
     paths-ignore:
-      - '.gitignore'
-      - '.readthedocs.yaml'
-      - 'README.rst'
+      - ".gitignore"
+      - ".readthedocs.yaml"
+      - "README.rst"
 
 env:
   PYTEST_DISCORD_WEBHOOK: ${{ secrets.PYTEST_DISCORD_WEBHOOK }}
@@ -26,7 +26,7 @@ jobs:
       image: ghcr.io/thombashi/python-ci:3.11
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - run: make build
 
@@ -40,42 +40,42 @@ jobs:
       image: ghcr.io/thombashi/python-ci:3.11
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - run: make docs
 
   lint:
     runs-on: ubuntu-latest
     concurrency:
-      group: ${{ github.workflow }}-${{ github.event_name }}-lint
+      group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-lint
       cancel-in-progress: true
     timeout-minutes: 20
     container:
       image: ghcr.io/thombashi/python-ci:3.11
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - run: make check
 
   unit-test:
     runs-on: ${{ matrix.os }}
     concurrency:
-      group: ${{ github.workflow }}-${{ github.event_name }}-ut-${{ matrix.os }}-${{ matrix.python-version }}
+      group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-ut-${{ matrix.os }}-${{ matrix.python-version }}
       cancel-in-progress: true
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', 'pypy-3.8']
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "pypy-3.8"]
         os: [ubuntu-latest, macos-latest, windows-latest]
         exclude:
           - os: macos-latest
-            python-version: 'pypy-3.8'
+            python-version: "pypy-3.8"
           - os: windows-latest
-            python-version: 'pypy-3.8'
+            python-version: "pypy-3.8"
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
@@ -100,17 +100,17 @@ jobs:
   coverage:
     runs-on: ubuntu-latest
     concurrency:
-      group: ${{ github.workflow }}-${{ github.event_name }}-coverage
+      group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-coverage
       cancel-in-progress: true
     timeout-minutes: 20
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: "3.10"
           cache: pip
           cache-dependency-path: |
             setup.py
@@ -137,12 +137,12 @@ jobs:
       cancel-in-progress: true
     timeout-minutes: 20
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.11'
+          python-version: "3.11"
           cache: pip
           cache-dependency-path: |
             setup.py

MANIFEST.in

@@ -1,6 +1,5 @@
 include LICENSE
 include README.rst
-include setup.cfg
 include tox.ini
 include docs/pages/introduction/summary.txt
 include */py.typed

Makefile

@@ -7,7 +7,6 @@ AUTHOR := thombashi
 PACKAGE := pytablewriter
 
 DOCS_DIR := docs
-DOCS_BUILD_DIR := $(DOCS_DIR)/_build
 BUILD_WORK_DIR := _work
 PKG_BUILD_DIR := $(BUILD_WORK_DIR)/$(PACKAGE)
 
@@ -70,7 +69,7 @@ readme:
 
 .PHONY: release
 release:
-	cd $(PKG_BUILD_DIR) && $(PYTHON) setup.py release --verbose --search-dir $(PACKAGE)
+	cd $(PKG_BUILD_DIR) && $(PYTHON) setup.py release --sign --verbose --search-dir $(PACKAGE)
 	$(MAKE) clean
 
 .PHONY: setup-actionlint
@@ -92,4 +91,4 @@ setup: setup-actionlint setup-ci setup-shellcheck
 
 .PHONY: test
 test:
-	@tox --verbose -e py
+	$(PYTHON) -m tox --verbose -e py

README.rst

@@ -159,16 +159,16 @@ Write a Markdown table
 
        Rendered markdown at GitHub
 
-Write a Markdown table with a margin
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Write a Markdown table with margins
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 :Sample Code:
     .. code-block:: python
 
         from pytablewriter import MarkdownTableWriter
 
         def main():
             writer = MarkdownTableWriter(
-                table_name="write an example with a margin",
+                table_name="write a table with margins",
                 headers=["int", "float", "str", "bool", "mix", "time"],
                 value_matrix=[
                     [0,   0.1,      "hoge", True,   0,      "2017-01-01 03:04:05+0900"],
@@ -186,7 +186,7 @@ Write a Markdown table with a margin
 :Output:
     .. code-block::
 
-        # write an example with a margin
+        # write a table with margins
         | int | float | str  | bool  |   mix    |           time           |
         | --: | ----: | ---- | ----- | -------: | ------------------------ |
         |   0 |  0.10 | hoge | True  |        0 | 2017-01-01 03:04:05+0900 |
@@ -196,6 +196,86 @@ Write a Markdown table with a margin
 
 ``margin`` attribute can be available for all of the text format writer classes.
 
+Write a GitHub Flavored Markdown (GFM) table
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+If you set ``flavor`` keyword argument of ``MarkdownTableWriter`` class to ``"github"`` or ``"gfm"``, the writer will output markdown tables with GitHub flavor.
+GFM can apply some additional styles to tables such as ``fg_color`` (text color).
+
+:Sample Code:
+    .. code-block:: python
+
+            from pytablewriter import MarkdownTableWriter
+            from pytablewriter.style import Style
+
+            writer = MarkdownTableWriter(
+                column_styles=[
+                    Style(fg_color="red"),
+                    Style(fg_color="green", decoration_line="underline"),
+                ],
+                headers=["A", "B"],
+                value_matrix=[
+                    ["abc", 1],
+                    ["efg", 2],
+                ],
+                margin=1,
+                flavor="github",
+                enable_ansi_escape=False,
+            )
+            writer.write_table()
+
+Rendered results can be found at `here <https://github.com/thombashi/pytablewriter/blob/master/docs/pages/examples/output/markdown/gfm.md>`__
+
+Apply styles to GFM table with programmatically
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+You can apply styles to specific cells by using style filters.
+Style filters will be written as functions.
+Example of a style filter function are as follows:
+
+:Sample Code:
+    .. code-block:: python
+
+            from typing import Any, Optional
+
+            from pytablewriter import MarkdownTableWriter
+            from pytablewriter.style import Cell, Style
+
+
+            def style_filter(cell: Cell, **kwargs: Any) -> Optional[Style]:
+                if cell.is_header_row():
+                    return None
+
+                if cell.col == 0:
+                    return Style(font_weight="bold")
+
+                value = int(cell.value)
+
+                if value > 80:
+                    return Style(fg_color="red", font_weight="bold", decoration_line="underline")
+                elif value > 50:
+                    return Style(fg_color="yellow", font_weight="bold")
+                elif value > 20:
+                    return Style(fg_color="green")
+
+                return Style(fg_color="lightblue")
+
+
+            writer = MarkdownTableWriter(
+                table_name="style filter example",
+                headers=["Key", "Value 1", "Value 2"],
+                value_matrix=[
+                    ["A", 95, 40],
+                    ["B", 55, 5],
+                    ["C", 30, 85],
+                    ["D", 0, 69],
+                ],
+                flavor="github",
+                enable_ansi_escape=False,
+            )
+            writer.add_style_filter(style_filter)
+            writer.write_table()
+
+Rendered results can be found at `here <https://github.com/thombashi/pytablewriter/blob/master/docs/pages/examples/output/markdown/style_filter.md>`__
+
 Write a Markdown table to a stream or a file
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 `Refer an example <https://github.com/thombashi/pytablewriter/blob/master/examples/py/stream/configure_stream.py>`__
@@ -581,13 +661,19 @@ Make tables for specific applications
 ---------------------------------------
 Render a table on Jupyter Notebook
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-https://nbviewer.jupyter.org/github/thombashi/pytablewriter/blob/master/examples/ipynb/jupyter_notebook_example.ipynb
+All table writer class instances in ``pytablewriter`` can render in Jupyter Notebook.
+To render writers at notebook cells, you will require the dependency packages to be installed either by:
+
+- ``pip install pytablewriter[html]`` or
+- ``pip install pytablewriter[all]``
+
+Jupyter Notebook code examples can be found `here <https://nbviewer.jupyter.org/github/thombashi/pytablewriter/blob/master/examples/ipynb/jupyter_notebook_example.ipynb>`__:
 
-.. figure:: https://cdn.jsdelivr.net/gh/thombashi/pytablewriter@master/docs/pages/examples/jupyter_notebook/ss/jupyter_notebook.png
+.. figure:: https://cdn.jsdelivr.net/gh/thombashi/pytablewriter@master/ss/jupyter_notebook.png
    :scale: 100%
-   :alt: https://github.com/thombashi/pytablewriter/blob/master/docs/pages/examples/jupyter_notebook/ss/jupyter_notebook.png
+   :alt: https://github.com/thombashi/pytablewriter/blob/master/ss/jupyter_notebook.png
 
-   Table formatting for Jupyter Notebook
+   Table rendering results of Jupyter Notebook
 
 Multibyte character support
 -----------------------------

docs/make_readme.py

@@ -25,12 +25,24 @@ def write_examples(maker: ReadmeMaker) -> None:
     maker.inc_indent_level()
 
     maker.write_chapter("Write a Markdown table")
-    maker.write_file(examples_root.joinpath("table_format", "text", "markdown_example.txt"))
+    maker.write_file(examples_root.joinpath("table_format", "text", "markdown", "md_example.txt"))
 
     with maker.indent():
-        maker.write_chapter("Write a Markdown table with a margin")
+        maker.write_chapter("Write a Markdown table with margins")
         maker.write_file(
-            examples_root.joinpath("table_format", "text", "markdown_example_with_margin.txt")
+            examples_root.joinpath("table_format", "text", "markdown", "md_example_with_margin.txt")
+        )
+
+        maker.write_chapter("Write a GitHub Flavored Markdown (GFM) table")
+        maker.write_file(
+            examples_root.joinpath("table_format", "text", "markdown", "md_example_with_flavor.txt")
+        )
+
+        maker.write_chapter("Apply styles to GFM table with programmatically")
+        maker.write_file(
+            examples_root.joinpath(
+                "table_format", "text", "markdown", "md_example_with_style_filter.txt"
+            )
         )
 
     with maker.indent():

docs/pages/examples/jupyter_notebook/jupyter_notebook_example.txt

@@ -1,7 +1,13 @@
-https://nbviewer.jupyter.org/github/thombashi/pytablewriter/blob/master/examples/ipynb/jupyter_notebook_example.ipynb
+All table writer class instances in ``pytablewriter`` can render in Jupyter Notebook.
+To render writers at notebook cells, you will require the dependency packages to be installed either by:
 
-.. figure:: https://cdn.jsdelivr.net/gh/thombashi/pytablewriter@master/docs/pages/examples/jupyter_notebook/ss/jupyter_notebook.png
+- ``pip install pytablewriter[html]`` or
+- ``pip install pytablewriter[all]``
+
+Jupyter Notebook code examples can be found `here <https://nbviewer.jupyter.org/github/thombashi/pytablewriter/blob/master/examples/ipynb/jupyter_notebook_example.ipynb>`__:
+
+.. figure:: https://cdn.jsdelivr.net/gh/thombashi/pytablewriter@master/ss/jupyter_notebook.png
    :scale: 100%
-   :alt: https://github.com/thombashi/pytablewriter/blob/master/docs/pages/examples/jupyter_notebook/ss/jupyter_notebook.png
+   :alt: https://github.com/thombashi/pytablewriter/blob/master/ss/jupyter_notebook.png
 
-   Table formatting for Jupyter Notebook
+   Table rendering results of Jupyter Notebook

docs/pages/examples/output/markdown/gfm.md

@@ -0,0 +1,5 @@
+# Markdown table with GitHub flavor
+|                 A                 |                       B                       |
+| --------------------------------- | --------------------------------------------: |
+| $$\textcolor{#cd3131}{\tt{abc}}$$ |   $$\textcolor{#0dbc79}{\underline{\tt{1}}}$$ |
+| $$\textcolor{#cd3131}{\tt{efg}}$$ |   $$\textcolor{#0dbc79}{\underline{\tt{2}}}$$ |

docs/pages/examples/output/markdown/style_filter.md

@@ -0,0 +1,7 @@
+# style filter example
+|Key|Value 1|Value 2|
+|---|------:|------:|
+|**A**|$$\textcolor{#cd3131}{\underline{\tt{\bf{95}}}}$$|$$\textcolor{#0dbc79}{\tt{40}}$$|
+|**B**|$$\textcolor{#e5e510}{\tt{\bf{55}}}$$|$$\textcolor{#3b8eea}{\tt{5}}$$|
+|**C**|$$\textcolor{#0dbc79}{\tt{30}}$$|$$\textcolor{#cd3131}{\underline{\tt{\bf{85}}}}$$|
+|**D**|$$\textcolor{#3b8eea}{\tt{0}}$$|$$\textcolor{#e5e510}{\tt{\bf{69}}}$$|

docs/pages/examples/table_format/text/index.rst

@@ -9,7 +9,7 @@ Text formats
    ltsv
    html
    json
-   markdown
+   markdown/markdown
    mediawiki
    rst/index
    sourcecode/index

docs/pages/examples/table_format/text/markdown/markdown.rst

@@ -0,0 +1,19 @@
+.. _example-markdown-table-writer:
+
+Markdown
+----------------------------
+|MarkdownTableWriter| class can write a table to the |stream| with Markdown table format from a data matrix.
+
+.. include:: md_example.txt
+
+Markdown with margins
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. include:: md_example_with_margin.txt
+
+GitHub flavored Markdown (GFM)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. include:: md_example_with_flavor.txt
+
+Apply styles to GFM table with programmatically
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. include:: md_example_with_style_style.txt