html-table-builder 0.1.1__py3-none-any.whl

html_table_builder/__init__.py

@@ -0,0 +1,2 @@
+def add(first: int, second: int) -> int:
+    return first + second

html_table_builder-0.1.1.dist-info/METADATA

@@ -0,0 +1,360 @@
+Metadata-Version: 2.4
+Name: html-table-builder
+Version: 0.1.1
+Summary: Library for creating HTML tables based on templates
+Author-email: Evgeny Borisov <maybe_i_will_read_it@internet.ru>
+License-Expression: MIT
+Project-URL: Homepage, https://gitflic.ru/project/evgeniiborisov1983/html-table-builder
+Project-URL: Repository, https://gitflic.ru/project/evgeniiborisov1983/html-table-builder.git
+Keywords: html,table,builder,template,grid
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.13.2
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: formats-to-structural-nodes>=0.1.0
+Requires-Dist: more-structural-nodes>=0.1.0
+Dynamic: license-file
+
+# The library for generating html (vertical) tables
+This library is necessary for creating html tables from prepared data contained in json formats, directories, arrays, and structural nodes (an additional library is more-structural-nodes). The library allows you to perform the following operations:
+1. Group data by parameter value;
+2. Sort data by parameter;
+3. Output parameter names;
+4. Output parameter values;
+5. Output property values (for BaseStructuralNode);
+6. Set auto-increment cells;
+7. Set a dictionary of names (for parameter conversion);
+8. Set headlines;
+9. Set table properties;
+## Template formation rules
+At the very top of the hierarchy is a table. The table is not allocated in a separate block.
+The next level is multiblock. Combines an array of blocks. For example, there may be a header block and a data block. In fact, the number of blocks is not limited.
+
+`"multiblock": {}`
+
+There is an array of blocks inside the multi block.
+
+`    "multiblock": {
+        "block_drivers": []
+}`
+
+The block can be one of the following types ("type"):
+1. object - incoming data in the block is perceived as an object. This type is necessary for non-duplicate data.
+2. array - incoming data is an array. Accordingly, corresponding cells will be created for each element of the array.
+3. array_by_object - all parameters will be extracted from the incoming object and processed as an array. This can be useful if the data is decomposed as parameters rather than an array.
+
+The block consists of lines.
+
+`"rows": []`
+
+The strings themselves consist of containers.
+
+`"containers": []`
+
+A container either describes the behavior for displaying data, or allows you to output a more complex data structure, starting with a multiblock. The nesting level is unlimited.
+
+An example of a container that allows you to output a multiblock:
+
+``` 
+[
+    {
+        "type": "multiblock",
+        "source": "multi_test",
+        "multiblock": {
+            "block_drivers": [
+                {
+                    "type": "array",
+                    "rows": [
+                        {
+                            "containers": [
+                                {
+                                        "type": "value",
+                                        "source": "a"
+                                },
+                                {
+                                        "type": "value",
+                                        "source": "b"
+                                }
+                             ]
+                        }
+                    ]
+                }
+            ]
+        }
+    }
+]
+```
+
+To reduce the nesting, it is allowed to specify the name of the multiblock, in accordance with the example:
+
+```
+[
+    {
+        "type": "multiblock",
+        "multiblock": "arrays_cena"
+    }
+]
+```
+
+The "multiblocks" section in the root directory is used to describe the multiblock.:
+
+```
+"multiblocks": {
+    "{multiblock name}": {
+        "block_drivers": [
+            {
+            ...
+            }
+        ]
+    }
+}
+```
+
+The following options are available to specify the filling of the cell data.
+
+Filling in the attribute name:
+```
+{
+    "type": "name"
+}
+```
+
+Filling in with a constant:
+```
+{
+    "type": "constant",
+    "value": "{value}"
+}
+```
+
+Filling in an attribute value along an arbitrary path relative to the incoming object:
+```
+{
+    "type": "value",
+    "source": "{attribute path relative to the incoming object}"
+}
+```
+
+Filling in the attribute value:
+```
+{
+    "type": "value"
+}
+```
+
+Filling in the auto-increment value:
+```
+{
+    "type": "auto-increment"
+}
+```
+
+Filling in the node property value:
+```
+{
+    "type": "parameter",
+    "source": "parameter name"
+}
+```
+
+# Example
+## Template
+```
+{
+    "parameters": {
+        "table": {
+            "border": "2"
+        }
+    },
+    "dictionaries": {
+        "main": {
+            "True": "Firm and clear",
+            "description": "Amazing narrative",
+            "value": "Meaningful",
+            "visible": "Look",
+            "victory": "Live!!!" 
+        }
+    },
+    "multiblock": {
+        "block_drivers": [
+            {
+                "type": "object",
+                "rows": [
+                    {
+                        "containers": [
+                            {
+                                "type": "constant",
+                                "value": "Parameter"
+                            },
+                            {
+                                "type": "constant",
+                                "value": "Name"
+                            },
+                            {
+                                "type": "constant",
+                                "value": "Value"
+                            }
+                        ]
+                    }
+                ]
+            },
+            {
+                "type": "array",
+                "rows": [
+                    {
+                        "containers": [
+                            {
+                                "type": "value",
+                                "source": "name"
+                            },
+                            {
+                                "type": "multiblock",
+                                "multiblock": "info"
+                            }
+                        ]
+                    }
+                ]
+            }
+        ]
+    },
+    "multiblocks": {
+        "info": {
+            "block_drivers": [
+                {
+                    "source": "info",
+                    "type": "object_as_array",
+                    "rows": [
+                        {
+                            "containers": [
+                                {
+                                    "type": "name",
+                                    "dictionary": "main"
+                                },
+                                {
+                                    "type": "value",
+                                    "dictionary": "main"
+                                }
+                            ]
+                        }
+                    ]
+                }
+            ]
+        }
+    }
+}
+```
+## Data
+```
+[
+    {
+        "name": "First",
+        "info": {
+            "description": "first one",
+            "value": 3,
+            "visible": true
+        }
+    },
+    {
+        "name": "Second",
+        "info": {
+            "description": "Difficult second",
+            "value": "Something smart",
+            "visible": true,
+            "victory": "Yes"
+        }
+    }
+]
+```
+## Result
+<table border="2">
+<tbody>
+    <tr>
+        <td colspan="1", rowspan="1"><div>Parameter</div></td>
+        <td colspan="1", rowspan="1"><div>Name</div></td>
+        <td colspan="1", rowspan="1"><div>Value</div></td>
+</tr>
+    <tr>
+        <td colspan="1", rowspan="3"><div>The first</div></td>
+        <td colspan="1", rowspan="1"><div>Amazing narration</div></td>
+        <td colspan="1", rowspan="1"><div>Just the first</div></td>
+</tr>
+    <tr>
+        <td colspan="1", rowspan="1"><div>Significant value</div></td>
+        <td colspan="1", rowspan="1"><div>3</div></td>
+    </tr>
+    <tr>
+        <td colspan="1", rowspan="1"><div>Visibility</div></td>
+        <td colspan="1", rowspan="1"><div>Firmly and clearly</div></td>
+</tr>
+    <tr>
+        <td colspan="1", rowspan="4"><div>The second</div></td>
+        <td colspan="1", rowspan="1"><div>Amazing narration</div></td>
+        <td colspan="1", rowspan="1"><div>The second one is difficult</div></td>
+</tr>
+    <tr>
+        <td colspan="1", rowspan="1"><div>Significant value</div></td>
+        <td colspan="1", rowspan="1"><div>Something smart</div></td>
+</tr>
+    <tr>
+        <td colspan="1", rowspan="1"><div>Visibility</div></td>
+        <td colspan="1", rowspan="1"><div>Firmly and clearly</div></td>
+</tr>
+    <tr>
+        <td colspan="1", rowspan="1"><div>Vivat!!!</div></td>
+        <td colspan="1", rowspan="1"><div>Yes</div></td>
+</tr>
+</tbody>
+</table>
+
+# Usage
+If you need to create only one table using a specific template, you can use the create_table function.
+
+Example
+```
+from html_table_builder import create_table
+import json
+
+template_file_name = "template.json"
+table_file_name = "test_table.json"
+result_file_name = "result.html"
+
+if __name__ == "__main__":
+    with open(template_file_name, mode="r", encoding="utf-8") as f:
+        template = json.load(f)
+    with open(table_file_name, mode="r", encoding="utf-8") as f:
+        table_json = json.load(f)
+    result = create_table(table_json, template)
+    with open(result_file_name, mode="w", encoding="utf-8") as f:
+        f.write(result)
+```
+
+If you need to create several tables with different data sources for the same template, it is better to create a table generator object and create tables through it.
+
+Example
+```
+from html_table_builder import TableGenerator
+import json
+
+
+if __name__ == "__main__":
+    with open(template_file_name, mode="r", encoding="utf-8") as f:
+        template = json.load(f)
+    table_generator = TableGenerator(template)
+    with open(table_file_name, mode="r", encoding="utf-8") as f:
+        table_json = json.load(f)
+    result = table_generator.create_table(table_json)
+    with open(result_file_name, mode="w", encoding="utf-8") as f:
+        f.write(result)
+```
+
+# About data conversion for table cells
+An object of the converter class inherited from the ConverterInterface interface is used to convert data from the source into data from table cells. A method must be implemented inside the interface.:
+
+- def convert(self, base_value: Any) -> str
+
+The converter object is passed by the last (optional) parameter in the TableGenerator constructor: TableGenerator(template, new_converter). Or when using the function: create_table(table_json, template, new_converter).
+If you don't pass your own object, then use your own one, which converts the received value to a string and wraps it in a div tag.

html_table_builder-0.1.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+html_table_builder/__init__.py,sha256=Gh11iAh8iSnHpiG1BYHDESBg-2qvXFCFz34LExX1Bmw,69
+html_table_builder-0.1.1.dist-info/licenses/LICENSE,sha256=H6bxDNp8-rCLTMRFiiszgr8wsm3Xp3epcE27DGXXg7g,1107
+html_table_builder-0.1.1.dist-info/METADATA,sha256=SPEpvR6PGY8Rlp2p6m86eNSEO5fKDeQEiON0zOmOSVg,11177
+html_table_builder-0.1.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+html_table_builder-0.1.1.dist-info/top_level.txt,sha256=j5o_FILhdoHxus9canCN_iBMs4WlbDOwD-Ly6B2Q5x0,19
+html_table_builder-0.1.1.dist-info/RECORD,,

html_table_builder-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

html_table_builder-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2026] [Borisov Evgeny Mikhailovich]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

html_table_builder-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+html_table_builder