Merge pull request #33 from Zandwhich/staging

The base implementation of printing the table. Creates a basic table with everything being right-justified.

Author: Zandwhich

README.md

@@ -1,4 +1,70 @@
-# Python-Table-Print
+# Python Table Print
 A project to dynamically scale and print tables using text in Python
 
-## More documentation to come soon!
+# Usage
+
+Python Table Print is object-oriented. This means that a `PrintTable` object gets instantiated and added to/edited. When the table is ready to be printed/created, this can be done by calling the `print_table`/`get_table` methods. An example can be found in `example.py`, but is copied here for convenience:
+
+```python
+from table import PrintTable
+
+my_table = PrintTable()
+
+my_table.add_row("Col 1", "Col 2", "Col 3")
+my_table.add_row("Entry 1", "Entry number 2", "Entry 3 baby")
+my_table.add_row("Another entry", "yay", "an entry in the table")
+my_table.add_row("Fun times", "This is kinda cool", "wooow")
+
+my_table.print_table()
+```
+
+Output:
+```
+**************************************************************
+*         Col 1 *              Col 2 *                 Col 3 *
+**************************************************************
+*       Entry 1 *     Entry number 2 *          Entry 3 baby *
+* Another entry *                yay * an entry in the table *
+*     Fun times * This is kinda cool *                 wooow *
+**************************************************************
+```
+
+In the above example, the `print_table` method was called which prints using the default `print` function. However, if the table in string form is preferred, then this is also easily achievable:
+
+```python
+from table import PrintTable
+
+my_table = PrintTable()
+
+...
+
+str_table = my_table.get_table()
+```
+
+## Header
+
+By default, the first row of the table is treated as the header of the table, and is printed with an extra border around it, not done for any other row. This behaviour can be turned off/on by setting the property `has_header` to `True`/`False`:
+
+```python
+from table import PrintTable
+
+table = PrintTable()
+
+table.add_row("Col 1", "Col 2", "Col 3")
+table.add_row("Entry 1", "Entry number 2", "Entry 3 baby")
+table.add_row("Another entry", "yay", "an entry in the table")
+table.add_row("Fun times", "This is kinda cool", "wooow")
+table.has_header_row = False
+
+table.print_table()
+```
+
+Output:
+```
+**************************************************************
+*         Col 1 *              Col 2 *                 Col 3 *
+*       Entry 1 *     Entry number 2 *          Entry 3 baby *
+* Another entry *                yay * an entry in the table *
+*     Fun times * This is kinda cool *                 wooow *
+**************************************************************
+```

python_table_print/__init__.py

@@ -0,0 +1 @@
+from table import PrintTable

python_table_print/example.py

@@ -0,0 +1,11 @@
+from table import PrintTable
+
+table = PrintTable()
+
+table.add_row("Col 1", "Col 2", "Col 3")
+table.add_row("Entry 1", "Entry number 2", "Entry 3 baby")
+table.add_row("Another entry", "yay", "an entry in the table")
+table.add_row("Fun times", "This is kinda cool", "wooow")
+table.has_header_row = False
+
+table.print_table()

python_table_print/table.py

@@ -0,0 +1,72 @@
+BASE_BORDER = "*"
+
+
+class PrintTable:
+    def __init__(self) -> None:
+        self.has_header_row = True
+
+        self._max_column_lengths = []
+        self._text = []
+
+    def add_row(self, *row: str) -> None:
+        for col_i in range(0, len(row)):
+            if (
+                len(row[col_i]) > self._max_column_lengths[col_i]
+                if col_i < len(self._max_column_lengths)
+                else -1
+            ):
+                if col_i < len(self._max_column_lengths):
+                    self._max_column_lengths[col_i] = len(row[col_i])
+                else:
+                    self._max_column_lengths += [len(row[col_i])]
+
+        self._text += [row]
+
+    def _total_border_length(self) -> int:
+        total_border_length = 0
+
+        for col_len in self._max_column_lengths:
+            total_border_length += col_len + 3 if not col_len == 0 else 2
+
+        return total_border_length + 1
+
+    def _get_border_row(self) -> str:
+        return BASE_BORDER * self._total_border_length() + "\n"
+
+    def _get_header(self, header: tuple[str, ...]) -> str:
+        header = self._get_row(header)
+        return header + self._get_border_row()
+
+    def _get_row(self, columns: tuple[str, ...]) -> str:
+        row = BASE_BORDER
+        for col_i in range(0, len(columns)):
+            if self._max_column_lengths[col_i] == 0:
+                row += " " + BASE_BORDER
+                continue
+
+            row += (
+                " " * (self._max_column_lengths[col_i] - len(columns[col_i]) + 1)
+                + columns[col_i]
+                + " "
+                + BASE_BORDER
+            )
+
+        return row + "\n"
+
+    def get_table(self) -> str:
+        if len(self._text) == 0:
+            # TODO: Throw an error here
+            return "ERROR: No text passed in for the table"
+
+        table = self._get_border_row()
+
+        if self.has_header_row:
+            table += self._get_header(self._text[0])
+
+        for r_row in range(1 if self.has_header_row else 0, len(self._text)):
+            table += self._get_row(self._text[r_row])
+
+        return table + self._get_border_row()
+
+    def print_table(self) -> None:
+        print(self.get_table())

src/python-table-print/__init__.py

@@ -0,0 +1,5 @@
+# TODO: Add testing for the table
+
+
+def test_temp():
+    assert True