Setup and initial version

Author: DenverCoder1

.gitignore

@@ -123,3 +123,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# VS Code Config
+.vscode/

requirements.txt

@@ -0,0 +1,2 @@
+[flake8]
+ignore = E501

setup.cfg

@@ -0,0 +1,95 @@
+# /usr/bin/env python
+import os
+from setuptools import setup
+from setuptools.command.test import test as TestCommand, Command
+
+
+class PyTest(TestCommand):
+    def finalize_options(self):
+        TestCommand.finalize_options(self)
+        self.test_args = ["tests", "-s"]
+        self.test_suite = True
+
+    def run_tests(self):
+        import pytest
+
+        errno = pytest.main(self.test_args)
+        raise SystemExit(errno)
+
+
+class LintCommand(Command):
+    """
+    A copy of flake8's Flake8Command
+    """
+
+    description = "Run flake8 on modules registered in setuptools"
+    user_options = []
+
+    def initialize_options(self):
+        # must override
+        pass
+
+    def finalize_options(self):
+        # must override
+        pass
+
+    def distribution_files(self):
+        if self.distribution.packages:
+            for package in self.distribution.packages:
+                yield package.replace(".", os.path.sep)
+
+        if self.distribution.py_modules:
+            for filename in self.distribution.py_modules:
+                yield "%s.py" % filename
+
+    def run(self):
+        from flake8.api.legacy import get_style_guide
+
+        flake8_style = get_style_guide(config_file="setup.cfg")
+        paths = self.distribution_files()
+        report = flake8_style.check_files(paths)
+        raise SystemExit(report.total_errors > 0)
+
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+with open("requirements.txt") as fh:
+    requirements = fh.read().split("\n")
+
+setup(
+    name="table2ascii",
+    version="1.0.0",
+    author="Jonah Lawrence",
+    author_email="jonah@freshidea.com",
+    description="Convert 2D Python lists into Unicode/Ascii tables",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/DenverCoder1/table2ascii",
+    packages=["table2ascii"],
+    classifiers=[
+        "Environment :: Web Environment",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 2.5",
+        "Programming Language :: Python :: 2.6",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Topic :: Utilities",
+    ],
+    python_requires=">=3.6",
+    install_requires=[requirements],
+    setup_requires=[
+        "flake8>=3.8,<4",
+    ],
+    tests_require=[
+        "pytest>=6.2,<7",
+    ],
+    cmdclass={
+        "test": PyTest,
+        "lint": LintCommand,
+    },
+)

setup.py

@@ -0,0 +1,160 @@
+from typing import List
+
+
+class TableToAscii:
+    def __init__(
+        self,
+        header_row: List[str],
+        body: List[List[str]],
+        footer_row: List[str],
+    ):
+        self.header_row = header_row
+        self.body = body
+        self.footer_row = footer_row
+        self.cell_width = 5
+        """
+        ╔═════╦═══════════════════════╗
+        ║  #  ║  G     H     R     S  ║
+        ╟─────╫───────────────────────╢
+        ║  1  ║  30    40    35    30 ║
+        ║  2  ║  30    40    35    30 ║
+        ╟─────╫───────────────────────╢
+        ║ SUM ║ 130   140   135   130 ║
+        ╚═════╩═══════════════════════╝
+        """
+        self.parts = {
+            "top_left_corner": "╔",
+            "top_right_corner": "╗",
+            "top_edge": "═",
+            "first_col_top_tee": "╦",
+            "top_tee": "═",
+            "left_edge": "║",
+            "header_row_sep": "─",
+            "footer_row_sep": "─",
+            "first_col_sep": "║",
+            "left_tee": "╟",
+            "middle_edge": " ",
+            "header_row_cross": "─",
+            "footer_row_cross": "─",
+            "first_col_cross": "╫",
+            "right_edge": "║",
+            "right_tee": "╢",
+            "bottom_left_corner": "╚",
+            "bottom_right_corner": "╝",
+            "bottom_edge": "═",
+            "first_col_bottom_tee": "╩",
+            "bottom_tee": "═",
+        }
+
+    def to_ascii(self) -> str:
+        cols = len(self.header_row)
+        # create table header
+        table = [
+            # ╔
+            self.parts["top_left_corner"]
+            # ═════╦
+            + self.parts["top_edge"] * self.cell_width + self.parts["first_col_top_tee"]
+            #
+            + (
+                (self.parts["top_edge"] * self.cell_width + self.parts["top_tee"])
+                * (cols - 1)
+            )[0:-1]
+            # ╗
+            + self.parts["top_right_corner"],
+            # ║
+            self.parts["left_edge"]
+            #  #  ║
+            + f"  {self.header_row[0]}  " + self.parts["first_col_sep"]
+            #    G     H     R     S
+            + self.parts["middle_edge"].join(
+                "  " + val + "  " for val in self.header_row[1:]
+            )
+            # ║
+            + self.parts["right_edge"],
+            # ╟
+            self.parts["left_tee"]
+            # ─────╫
+            + (
+                self.parts["header_row_sep"] * self.cell_width
+                + self.parts["first_col_cross"]
+            )
+            # ───────────────────────
+            + (
+                (
+                    self.parts["header_row_sep"] * self.cell_width
+                    + self.parts["header_row_cross"]
+                )
+                * (cols - 1)
+            )[0:-1]
+            # ╢
+            + self.parts["right_tee"],
+        ]
+        # add table body
+        for p in self.body:
+            # add table row
+            table += [
+                # ║
+                self.parts["left_edge"]
+                +
+                #  1  ║
+                f"  {p[0]}  "
+                + self.parts["first_col_sep"]
+                #  40    40    40    40
+                + self.parts["middle_edge"].join(
+                    f"{p[i].rjust(4)} " for i in range(1, cols)
+                )
+                # ║
+                + self.parts["right_edge"]
+            ]
+        # footer row
+        table += [
+            # ╟
+            self.parts["left_tee"]
+            # ─────╫
+            + (
+                self.parts["footer_row_sep"] * self.cell_width
+                + self.parts["first_col_cross"]
+            )
+            # ───────────────────────
+            + (
+                (
+                    self.parts["footer_row_sep"] * self.cell_width
+                    + self.parts["footer_row_cross"]
+                )
+                * (cols - 1)
+            )[0:-1]
+            # ╢
+            + self.parts["right_tee"],
+            # ║
+            self.parts["left_edge"]
+            #  SUM ║
+            + f"{self.footer_row[0].rjust(4)} " + self.parts["first_col_sep"]
+            #  120 ║ 120 ║ 120 ║ 120 ║
+            + self.parts["middle_edge"].join(
+                f"{self.footer_row[i].rjust(4)} " for i in range(1, cols)
+            )
+            # ║
+            + self.parts["right_edge"],
+            # ╚
+            self.parts["bottom_left_corner"]
+            # ═════╩
+            + self.parts["bottom_edge"] * self.cell_width
+            + self.parts["first_col_bottom_tee"]
+            # ════════════════════════
+            + (
+                (self.parts["bottom_edge"] * self.cell_width + self.parts["bottom_tee"])
+                * (cols - 1)
+            )[0:-1]
+            # ╗
+            + self.parts["bottom_right_corner"],
+        ]
+        return "\n".join(table)
+
+
+def table2ascii(
+    header_row: List[str], body: List[List[str]], footer_row: List[str]
+) -> str:
+    """Convert a 2D Python table to ASCII text
+    #TODO: add param documentation
+    """
+    return TableToAscii(header_row, body, footer_row).to_ascii()