tableskill 0.3.0__py3-none-any.whl

tableskill/__init__.py

@@ -0,0 +1 @@
+from tableskill.tableskill import tableskill

tableskill/tableskill.py

@@ -0,0 +1,120 @@
+# Standard library
+from datetime import date
+import os
+
+# Third party packages
+import polars as pl
+
+# Local modules
+
+### FUNCTION -----------------------------------------------------------------------------------------------------------
+
+
+def tableskill(
+    dataframe_dict: dict[str, pl.DataFrame] = {"dataframe_name": pl.DataFrame()},
+    *,
+    sub_folder_in_export: str = "",
+    test_mode: bool = False,
+) -> str:
+    """
+    Converts a dictionary of Polars dataframes into csv files suitable for visualization in TableSkill.
+    (https://www.tableskill.com/)
+
+    Parameters
+    ----------
+    dataframe_dict : dict[str, pl.DataFrame`]
+        Dictionary with DataFrames to export
+
+    sub_folder_in_export : str
+        sub_folder when exporting (optional)
+
+    Returns
+    -------
+    pathstring : str
+        string of path where flat files were exported
+
+    """
+
+    ### SET CONSTANTS ------------------------------------------------------------------------------------------------------
+    if "USERPRINCIPALNAME" in os.environ:
+        user_surname = os.environ["USERPRINCIPALNAME"].split(".")[1].split("@")[0]
+    else:
+        user_surname = "DOE"
+
+    # Note sure who/what sets USERPRINCIPALNAME (email address), but here used to filter out surname
+    # user_surname = os.environ["USERPRINCIPALNAME"].split(".")[1].split("@")[0]
+    os.environ["USER_SURNAME"] = user_surname
+
+    export_folder = os.path.join(
+        # Path of home directory
+        os.path.expanduser("~"),
+        # environment variable USER_SURNAME, if it exists, otherwise empty string
+        os.environ.get("USER_SURNAME", ""),
+        # os.environ.get("USER_SURNAME", "Levy"),
+        # partial path
+        os.path.normpath("temp/tableskill"),
+        # Today's date as string with format yyyymmdd
+        date.today().strftime("%Y%m%d"),
+        os.path.normpath(sub_folder_in_export),
+    )
+
+    ### EXPORT DATAFRAMES TO FLAT FILES ------------------------------------------------------------------------------------
+    if not os.path.exists(export_folder):
+        os.makedirs(export_folder)
+
+    for key, value in dataframe_dict.items():
+        # print("key = ", key, " and value = ", value)
+        export_filename = key
+        export_filename_suffix = ".csv"
+        export_filepath = os.path.join(
+            export_folder, export_filename + export_filename_suffix
+        )
+        # print("export_filpath = ", export_filepath)
+        value.write_csv(export_filepath)
+
+    ### RETURN VALUE -------------------------------------------------------------------------------------------------------
+
+    # if test_mode:
+
+    return export_folder
+    # pass
+
+
+### TEST ---------------------------------------------------------------------------------------------------------------
+if __name__ == "__main__":
+
+    from datetime import datetime
+
+    # Create two dataframes from scratch
+    my_df1 = pl.DataFrame(
+        {
+            "integer": [1, 2, 3],
+            "date": [
+                datetime(2025, 1, 1),
+                datetime(2025, 1, 2),
+                datetime(2025, 1, 3),
+            ],
+            "float": [4.1, 5.2, 6.3],
+            "string": ["a", "b", "c"],
+        }
+    )
+
+    my_df2 = pl.DataFrame(
+        {
+            "an_integer": range(10),
+        }
+    )
+
+    # Define a dictionary for the 2 dataframes
+    my_dataframe_dict = {
+        "1 my_df1": my_df1,
+        "2 my_df2": my_df2,
+    }
+
+    # Export the dataframes to tableskill using the function defined here
+    test_call = tableskill(
+        dataframe_dict=my_dataframe_dict,
+        sub_folder_in_export="tableskill",
+    )
+
+    print("test_call = ", test_call)

tableskill-0.3.0.dist-info/METADATA

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: tableskill
+Version: 0.3.0
+Summary: A Python package to visualize tabular data via https://www.tableskill.com/
+Author-email: Walter Levy <klwlevy@hotmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Walter Levy <klwlevy@hotmail.com> and contributors
+        
+        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.
+Project-URL: Repository, https://github.com/klwlevy/tableskill.git
+Classifier: Programming Language :: Python
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: polars>=1.0
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: tableskill[docs]; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Dynamic: license-file
+
+# TableSkill
+
+Python package for visualization of tabular data via https://www.tableskill.com/  
+Specifically, polars (https://pola.rs/) dataframes are supported.
+
+# Usage:
+
+You can comfortably visualize your polars dataframes in tableskill as in this self-contained example:
+```python
+
+import tableskill as ts
+import polars as pl
+
+from datetime import datetime
+
+# Create two dataframes from scratch
+my_df1 = pl.DataFrame(
+    {
+        "integer": [1, 2, 3],
+        "date": [
+            datetime(2025, 1, 1),
+            datetime(2025, 1, 2),
+            datetime(2025, 1, 3),
+        ],
+        "float": [4.1, 5.2, 6.3],
+        "string": ["a", "b", "c"],
+    }
+)
+
+my_df2 = pl.DataFrame(
+    {
+        "an_integer": range(10),
+    }
+)
+
+# Define a dictionary for the 2 dataframes
+my_dataframe_dict = {
+    "1 my_df": my_df1,
+    "2 my_df": my_df2,
+}
+
+# Export the dataframes to tableskill using the tableskill function
+ts.tableskill(
+    dataframe_dict = my_dataframe_dict,
+    sub_folder_in_export = "tableskill_sample",
+)
+```
+
+The above will generate flat files suitable for https://www.tableskill.com/ on your hard drive under 
+`~\<LAST_NAME>\temp\tableskill\<YYYYMMDD>\tableskill_sample\`  
+You can simply drag invidual files or an entire folder structure into TableSkill.

tableskill-0.3.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+tableskill/__init__.py,sha256=hsUOACjRNuztrwoKV9NVlujb_ecX6M8gnzIT6gXSNCE,44
+tableskill/tableskill.py,sha256=wTIO_E-0X7X0c3mnoOjax8gvi7NoFYAfbQegmhp6jyg,3660
+tableskill-0.3.0.dist-info/licenses/LICENSE,sha256=VuxjVcIAhQ51F06nTYKkGwfPzG30kUiiiAnY5bkJvgo,1106
+tableskill-0.3.0.dist-info/METADATA,sha256=HLtXoqbaSDMPz4Cq9jg7gOAOczbS37MhcT-kfGut2WE,3252
+tableskill-0.3.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+tableskill-0.3.0.dist-info/top_level.txt,sha256=V41pGWwoOhVWR6VQ9ayIi5YcFphvPcSkW6xDAgmDpmw,11
+tableskill-0.3.0.dist-info/RECORD,,

tableskill-0.3.0.dist-info/WHEEL

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

tableskill-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Walter Levy <klwlevy@hotmail.com> and contributors
+
+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.

tableskill-0.3.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+tableskill