gov-uk-dashboards 24.0.0__tar.gz → 24.1.1__tar.gz

{gov_uk_dashboards-24.0.0/gov_uk_dashboards.egg-info → gov_uk_dashboards-24.1.1}/PKG-INFO

@@ -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 → gov_uk_dashboards-24.1.1}/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-24.1.1/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-24.0.0 → gov_uk_dashboards-24.1.1}/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 → gov_uk_dashboards-24.1.1/gov_uk_dashboards.egg-info}/PKG-INFO

@@ -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 → gov_uk_dashboards-24.1.1}/gov_uk_dashboards.egg-info/SOURCES.txt

@@ -106,6 +106,7 @@ gov_uk_dashboards/formatting/human_readable.py
 gov_uk_dashboards/formatting/number_formatting.py
 gov_uk_dashboards/formatting/round_and_add_prefix_and_suffix.py
 gov_uk_dashboards/formatting/rounding.py
+gov_uk_dashboards/formatting/text_functions.py
 gov_uk_dashboards/lib/__init__.py
 gov_uk_dashboards/lib/enable_basic_auth.py
 gov_uk_dashboards/lib/http_headers.py

{gov_uk_dashboards-24.0.0 → gov_uk_dashboards-24.1.1}/setup.py

@@ -10,7 +10,7 @@ setup(
     author="Department for Levelling Up, Housing and Communities",
     description="Provides access to functionality common to creating a data dashboard.",
     name="gov_uk_dashboards",
-    version="24.0.0",
+    version="24.1.1",
     long_description=long_description,
     long_description_content_type="text/markdown",
     packages=find_packages(),