.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
   build-package:
     runs-on: ubuntu-latest
     concurrency:
-      group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-build
+      group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-build-pkg
       cancel-in-progress: true
     timeout-minutes: 20
     container:
@@ -33,7 +33,7 @@ jobs:
   build-docs:
     runs-on: ubuntu-latest
     concurrency:
-      group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-docs
+      group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref_name }}-build-docs
       cancel-in-progress: true
     timeout-minutes: 20
     container:
@@ -66,7 +66,8 @@ jobs:
     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", "3.12", "pypy-3.8"]
         os: [ubuntu-latest, macos-latest, windows-latest]
         exclude:
           - os: macos-latest
@@ -90,12 +91,10 @@ jobs:
       - name: Install pip
         run: python -m pip install --upgrade --disable-pip-version-check "pip>=21.1"
 
-      - name: Install dependencies
-        run: make setup-ci
+      - run: make setup-ci
 
-      - name: Run tests
+      - run: make test
         timeout-minutes: 20
-        run: tox --verbose -e py
 
   coverage:
     runs-on: ubuntu-latest
@@ -117,8 +116,7 @@ jobs:
             **/*requirements.txt
             tox.ini
 
-      - name: Install dependencies
-        run: make setup-ci
+      - run: make setup-ci
 
       - name: Run tests
         run: tox -e cov
@@ -149,9 +147,9 @@ jobs:
             **/*requirements.txt
 
       - name: Install dependencies
-        run: python -m pip install --upgrade --disable-pip-version-check .[all] jupyter
+        run: python -m pip install --upgrade --disable-pip-version-check .[all] jupyter tblfaker
 
-      - name: Run tests
+      - name: Run examples
         run: |
           set -eux
 

README.rst

@@ -227,54 +227,8 @@ Rendered results can be found at `here <https://github.com/thombashi/pytablewrit
 
 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>`__
+Applying style filters to GFM allows for more flexible style settings for cells.
+See also the `example <#style-filter>`_
 
 Write a Markdown table to a stream or a file
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -449,7 +403,7 @@ Adding a column of the DataFrame index if you specify ``add_index_column=True``:
         |a  |  1| 10|
         |b  |  2| 11|
 
-Write a markdown table from space-separated values
+Write a Markdown table from space-separated values
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 :Sample Code:
     .. code-block:: python
@@ -626,13 +580,66 @@ You can also set ``Style`` to a specific column with an index or header by using
 
 Style filter
 ~~~~~~~~~~~~~~
+You can apply styles to specific cells by using style filters.
+Style filters will be written as Python functions.
+Examples of a style filter function and how you apply it 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>`__
+
+Theme
+~~~~~~~
+Themes consists of a set of style filters.
 The following command will install external predefined themes:
 
 ::
 
     pip install pytablewriter[theme]
 
-``theme`` argument of writer constructor or ``set_theme`` method can set"" predefined style filters.
+Themes can be set via the constructor of the writer classes or the ``set_theme`` method.
+The following is an example of setting the ``altrow`` theme via the constructor.
 ``altrow`` theme will be colored rows alternatively:
 
 :Sample Code:
@@ -654,8 +661,12 @@ The following command will install external predefined themes:
        :scale: 100%
        :alt: https://github.com/thombashi/pytablewriter-altrow-theme/blob/master/ss/ptw-altrow-theme_example_default.png
 
-Themes can be created as plugins like as follows:
-https://github.com/thombashi/pytablewriter-altrow-theme
+`[theme]` extras includes the following themes:
+
+- `pytablewriter-altrow-theme <https://github.com/thombashi/pytablewriter-altrow-theme>`__
+    - `Generated HTML table example <https://thombashi.github.io/pytablewriter-altrow-theme/example.html>`__
+- `pytablewriter-altcol-theme <https://github.com/thombashi/pytablewriter-altcol-theme>`__
+    - `Generated HTML table example <https://thombashi.github.io/pytablewriter-altcol-theme/example.html>`__
 
 Make tables for specific applications
 ---------------------------------------
@@ -761,6 +772,7 @@ Optional dependencies
     - `SimpleSQLite <https://github.com/thombashi/SimpleSQLite>`__
 - ``theme`` extras
     - `pytablewriter-altrow-theme <https://github.com/thombashi/pytablewriter-altrow-theme>`__
+    - `pytablewriter-altcol-theme <https://github.com/thombashi/pytablewriter-altcol-theme>`__
 - ``toml`` extras
     - `toml <https://github.com/uiri/toml>`__
 

docs/make_readme.py

@@ -5,13 +5,23 @@
 """
 
 import sys
+from typing import Final
 
 from path import Path
 from readmemaker import ReadmeMaker
 
 
-PROJECT_NAME = "pytablewriter"
-OUTPUT_DIR = ".."
+PROJECT_NAME: Final = "pytablewriter"
+OUTPUT_DIR: Final = ".."
+
+
+class Chapter:
+    STYLE_FILTER: Final = "Style filter"
+
+
+def make_internal_link(title: str, chapter: str) -> str:
+    link = chapter.replace(" ", "-").lower()
+    return f"`{title:s} <#{link:s}>`_"
 
 
 def write_examples(maker: ReadmeMaker) -> None:
@@ -39,10 +49,11 @@ def write_examples(maker: ReadmeMaker) -> None:
         )
 
         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"
-            )
+        maker.write_lines(
+            [
+                "Applying style filters to GFM allows for more flexible style settings for cells.",
+                "See also the {}".format(make_internal_link("example", Chapter.STYLE_FILTER)),
+            ]
         )
 
     with maker.indent():
@@ -71,7 +82,7 @@ def write_examples(maker: ReadmeMaker) -> None:
     maker.write_chapter("Write a Markdown table from ``pandas.DataFrame`` instance")
     maker.write_file(examples_root.joinpath("datasource", "from_pandas_dataframe_example.txt"))
 
-    maker.write_chapter("Write a markdown table from space-separated values")
+    maker.write_chapter("Write a Markdown table from space-separated values")
     maker.write_file(examples_root.joinpath("datasource", "from_ssv_example.txt"))
 
     maker.set_indent_level(1)
@@ -84,7 +95,14 @@ def write_examples(maker: ReadmeMaker) -> None:
     maker.write_chapter("Column styles")
     maker.write_file(examples_root.joinpath("style", "column_style_example.txt"))
 
-    maker.write_chapter("Style filter")
+    maker.write_chapter(Chapter.STYLE_FILTER)
+    maker.write_file(
+        examples_root.joinpath(
+            "table_format", "text", "markdown", "md_example_with_style_filter.txt"
+        )
+    )
+
+    maker.write_chapter("Theme")
     maker.write_file(examples_root.joinpath("style", "theme.txt"))
 
     maker.set_indent_level(1)

docs/pages/examples/style/theme.txt

@@ -1,10 +1,12 @@
+Themes consists of a set of style filters.
 The following command will install external predefined themes:
 
 ::
 
     pip install pytablewriter[theme]
 
-``theme`` argument of writer constructor or ``set_theme`` method can set"" predefined style filters.
+Themes can be set via the constructor of the writer classes or the ``set_theme`` method.
+The following is an example of setting the ``altrow`` theme via the constructor.
 ``altrow`` theme will be colored rows alternatively:
 
 :Sample Code:
@@ -26,5 +28,9 @@ The following command will install external predefined themes:
        :scale: 100%
        :alt: https://github.com/thombashi/pytablewriter-altrow-theme/blob/master/ss/ptw-altrow-theme_example_default.png
 
-Themes can be created as plugins like as follows:
-https://github.com/thombashi/pytablewriter-altrow-theme
+`[theme]` extras includes the following themes:
+
+- `pytablewriter-altrow-theme <https://github.com/thombashi/pytablewriter-altrow-theme>`__
+    - `Generated HTML table example <https://thombashi.github.io/pytablewriter-altrow-theme/example.html>`__
+- `pytablewriter-altcol-theme <https://github.com/thombashi/pytablewriter-altcol-theme>`__
+    - `Generated HTML table example <https://thombashi.github.io/pytablewriter-altcol-theme/example.html>`__

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

@@ -14,6 +14,6 @@ GitHub flavored Markdown (GFM)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. include:: md_example_with_flavor.txt
 
-Apply styles to GFM table with programmatically
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Apply styles to GFM table with programmatically (style filter)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. include:: md_example_with_style_style.txt

docs/pages/examples/table_format/text/markdown/md_example_with_style_filter.txt

@@ -1,6 +1,6 @@
 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:
+Style filters will be written as Python functions.
+Examples of a style filter function and how you apply it are as follows:
 
 :Sample Code:
     .. code-block:: python

docs/pages/introduction/dependencies.rst

@@ -21,5 +21,6 @@ Optional dependencies
     - `SimpleSQLite <https://github.com/thombashi/SimpleSQLite>`__
 - ``theme`` extras
     - `pytablewriter-altrow-theme <https://github.com/thombashi/pytablewriter-altrow-theme>`__
+    - `pytablewriter-altcol-theme <https://github.com/thombashi/pytablewriter-altcol-theme>`__
 - ``toml`` extras
     - `toml <https://github.com/uiri/toml>`__

docs/pages/reference/index.rst

@@ -9,4 +9,5 @@ Reference
    table_format
    style
    function
+   theme
    error

docs/pages/reference/theme.rst

@@ -0,0 +1,16 @@
+Theme
+---------------
+
+.. autoclass:: pytablewriter.style.StyleFilterFunc
+   :members:
+   :undoc-members:
+   :special-members: __call__
+
+.. autoclass:: pytablewriter.style.ColSeparatorStyleFilterFunc
+   :members:
+   :undoc-members:
+   :special-members: __call__
+
+.. autoclass:: pytablewriter.style.Theme
+   :members:
+   :undoc-members: