gov-uk-dashboards 24.0.0__py3-none-any.whl → 24.1.1__py3-none-any.whl

gov_uk_dashboards/components/dash/table.py

@@ -4,6 +4,7 @@ import polars as pl
 from dash import html, dcc
 from gov_uk_dashboards.components.dash.card import card
 from gov_uk_dashboards.components.dash.paragraph import paragraph
+from gov_uk_dashboards.formatting.text_functions import create_id_from_string
 
 
 def table_from_polars_dataframe(
@@ -16,6 +17,7 @@ def table_from_polars_dataframe(
     format_column_headers_as_markdown: bool = False,
     sortable_headers: bool = False,
     table_id: str = "table",
+    assign_ids_to_rows: bool = False,
     table_footer: str = None,
     column_widths: Optional[list[str]] = None,
     columns_to_right_align: Optional[list[str]] = None,
@@ -48,6 +50,7 @@ def table_from_polars_dataframe(
         sortable_headers: (bool, optional): Sets if the column headers should be sortable. Defaults
             to False.
         table_id: (str, optional): ID for the table Defaults to "table".
+        assign_ids_to_rows: (bool, optional): Adds id's to table rows when True. Defaults to False.
         table_footer: (str, optional): Text to display underneath table as footer.
         column_widths: (list[str], optional): Determines width of table columns. Format as a list,
             "x%". List must be same length as dataframe columns. Defaults to None.
@@ -187,7 +190,14 @@ def table_from_polars_dataframe(
                                 else {},
                             )
                             for cell, column_name in zip(row[1:], dataframe.columns[1:])
-                        ]
+                        ],
+                        **(
+                            {
+                                "id": create_id_from_string(row[0])
+                                if assign_ids_to_rows and create_id_from_string(row[0])
+                                else {}
+                            }
+                        ),
                     )
                     if first_column_is_header and index != last_row_index
                     else html.Tr(
@@ -200,7 +210,14 @@ def table_from_polars_dataframe(
                                 else {},
                             )
                             for cell, column_name in zip(row, dataframe.columns)
-                        ]
+                        ],
+                        **(
+                            {
+                                "id": create_id_from_string(row[0])
+                                if assign_ids_to_rows and create_id_from_string(row[0])
+                                else {}
+                            }
+                        ),
                     )
                 )
                 for index, row in enumerate(dataframe.rows())

gov_uk_dashboards/formatting/text_functions.py

@@ -0,0 +1,11 @@
+"""Functions to format text"""
+
+import re
+
+
+def create_id_from_string(string):
+    """Function to create an id from a string. Remove non alphanumeric characters and replaces
+    spaces with dashes"""
+    if string is None:
+        return ""
+    return re.sub(r"[^a-z0-9]+", "-", string.lower()).strip("-")

gov_uk_dashboards/lib/datetime_functions/datetime_functions.py

@@ -163,6 +163,11 @@ def get_todays_date_for_downloaded_csv() -> str:
     return str(datetime.today().strftime("%d/%m/%Y"))
 
 
+def convert_datetime_to_dd_mm_yyy_string(input_datetime: datetime):
+    """convert datetime to DD/MM/YYYY string"""
+    return str(input_datetime.strftime("%d/%m/%Y"))
+
+
 def date_string_is_full_month_and_full_year_format(date_string: str):
     """checks if a date string is in the format $B $Y"""
     try:

{gov_uk_dashboards-24.0.0.dist-info → gov_uk_dashboards-24.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 24.0.0
+Version: 24.1.1
 Summary: Provides access to functionality common to creating a data dashboard.
 Author: Department for Levelling Up, Housing and Communities
 Description-Content-Type: text/markdown

{gov_uk_dashboards-24.0.0.dist-info → gov_uk_dashboards-24.1.1.dist-info}/RECORD

@@ -65,7 +65,7 @@ gov_uk_dashboards/components/dash/paragraph.py,sha256=yoWa_B6RLiebBX2QaszY3lyZEx
 gov_uk_dashboards/components/dash/phase_banner.py,sha256=7XIk_y-kStSaptXnk9yHVu8S0n-ypwWehDqOwjb5l-c,1787
 gov_uk_dashboards/components/dash/row_component.py,sha256=SdmJqyFJA1Kngyzxy0ooZUegIOiN6Bz1wRq6jGigfII,687
 gov_uk_dashboards/components/dash/side_navbar.py,sha256=pupA0FdjSbPbzdX9up6wEoIKWIuk3zGRun4opnBieCU,1332
-gov_uk_dashboards/components/dash/table.py,sha256=TJ21lWZ3xFueHyg9xq2YbXp5Z-8kUEovr4L0zXTVGvg,10220
+gov_uk_dashboards/components/dash/table.py,sha256=Jt2dFddWsXBaLBXVdO1QKntrT4MYZeG2GgwYycldi64,11060
 gov_uk_dashboards/components/dash/tooltip.py,sha256=qTkRWQanhG535Yi4NiaLlEMJqqzjubgRdKJDIhxXzd4,978
 gov_uk_dashboards/components/dash/tooltip_title.py,sha256=2exMYItzR17yOu3gTL77DyUU4Hi3CIB-ZPS8ftetqZg,874
 gov_uk_dashboards/components/dash/visualisation_commentary.py,sha256=jBy8qy2DWYqodqDZ8QdDmgOO_USDSwn2Sj5CnL58VMM,648
@@ -97,6 +97,7 @@ gov_uk_dashboards/formatting/human_readable.py,sha256=o5-Xlbm7wP_4wU9mIdsG0ztU5a
 gov_uk_dashboards/formatting/number_formatting.py,sha256=9LVqKqx0mMQyv8XLI_im1pdASZDJxRjzRWtRN-g6kPs,913
 gov_uk_dashboards/formatting/round_and_add_prefix_and_suffix.py,sha256=_DboRfdvwb9Y62H9LFDFJ0ju4626z-_oFuwagRgyZDY,1456
 gov_uk_dashboards/formatting/rounding.py,sha256=Em1yri_j18IYHbZ64d3bhVKX-XEllRSM9FzAUo1o6fU,968
+gov_uk_dashboards/formatting/text_functions.py,sha256=vHstpUo16LnsSk-rzwFDNP1SIAy2npIo-4ims1xNa64,306
 gov_uk_dashboards/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gov_uk_dashboards/lib/enable_basic_auth.py,sha256=Ul2tnopTJm6_UQ1ljKGwk-Ay3Z8KnPNKNjwiBOf1yd0,749
 gov_uk_dashboards/lib/http_headers.py,sha256=Hur3R0_hAsWz8PntBhD66w4kgdW6EvwHNNugnA0DIJM,1592
@@ -105,12 +106,12 @@ gov_uk_dashboards/lib/dap/__init__.py,sha256=bYga8kJuf9TGkfpnd16SInrD1FcN8iPn4Sz
 gov_uk_dashboards/lib/dap/dap_deployment.py,sha256=ZXixeOAtRNjMsPdGKLwwLNamlo0miZLaKCckKtq8_iI,2313
 gov_uk_dashboards/lib/dap/get_dataframe_from_cds.py,sha256=6DUaoVBO4YqwiuCXvetE8_t-8mVcO27HnCRKlzz8Hpk,4090
 gov_uk_dashboards/lib/datetime_functions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gov_uk_dashboards/lib/datetime_functions/datetime_functions.py,sha256=BQgr8I_vFNYwLi-fE4YC6jZ5PpbPea2rnD_2a_lw0YE,12209
+gov_uk_dashboards/lib/datetime_functions/datetime_functions.py,sha256=e1RXgLBD37n2slm4fKcFSIrb6O9ZoFROceZHO5CUzj8,12379
 gov_uk_dashboards/lib/download_functions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gov_uk_dashboards/lib/download_functions/convert_fig_to_image_and_download.py,sha256=-dkYbpTL6txftFfAZW-vfW_O9efb6Dse9WJ9MM6mAqw,534
 gov_uk_dashboards/lib/download_functions/download_csv_with_headers.py,sha256=aLL3UodmilZA_1bQhtjtKi3FoB-4X_MtLOcDw5e1Nwo,4412
-gov_uk_dashboards-24.0.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
-gov_uk_dashboards-24.0.0.dist-info/METADATA,sha256=dGVh5xbbOEk_7RcARicohjQMSukSaAzfDAFt8w8a9mw,5890
-gov_uk_dashboards-24.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-gov_uk_dashboards-24.0.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
-gov_uk_dashboards-24.0.0.dist-info/RECORD,,
+gov_uk_dashboards-24.1.1.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
+gov_uk_dashboards-24.1.1.dist-info/METADATA,sha256=-E9u_Wvs85lErIoWT9fHIEnFLPw_2FGii3mHAq0V6kY,5890
+gov_uk_dashboards-24.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gov_uk_dashboards-24.1.1.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
+gov_uk_dashboards-24.1.1.dist-info/RECORD,,