gov-uk-dashboards 13.5.2__tar.gz → 15.0.0__tar.gz

{gov_uk_dashboards-13.5.2/gov_uk_dashboards.egg-info → gov_uk_dashboards-15.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 13.5.2
+Version: 15.0.0
 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-13.5.2 → gov_uk_dashboards-15.0.0}/gov_uk_dashboards/components/__init__.py

@@ -4,4 +4,4 @@ using different systems.
 Contains:
 - plotly: Module containing Plotly/Dash components
 """
-from . import plotly
+from . import dash

{gov_uk_dashboards-13.5.2/gov_uk_dashboards/components/plotly → gov_uk_dashboards-15.0.0/gov_uk_dashboards/components/dash}/__init__.py

@@ -1,4 +1,4 @@
-"""Module containing Plotly/Dash components for building GOV.UK Design System dashboards.
+"""Module containing Dash components for building GOV.UK Design System dashboards.
 
 See: https://design-system.service.gov.uk/components/
 
@@ -63,7 +63,7 @@ the right
 """
 
 from .banners import message_banner
-from .captioned_figure import captioned_figure
+from ..plotly.captioned_figure import captioned_figure
 from .card import card, empty_card
 from .card_full_width import card_full_width
 from .apply_and_reset_filters_buttons import apply_and_reset_filters_buttons

{gov_uk_dashboards-13.5.2/gov_uk_dashboards/components → gov_uk_dashboards-15.0.0/gov_uk_dashboards/components/dash}/create_download_chart_button.py

@@ -1,7 +1,7 @@
 """create_download_chart_button"""
 
 from dash import html
-from gov_uk_dashboards.components.plotly import download_button_with_icon
+from gov_uk_dashboards.components.dash import download_button_with_icon
 
 
 def create_download_chart_button(button_id_name: str) -> html.Div:

{gov_uk_dashboards-13.5.2/gov_uk_dashboards/components → gov_uk_dashboards-15.0.0/gov_uk_dashboards/components/dash}/create_download_data_button.py

@@ -1,7 +1,7 @@
 """create_download_data_button"""
 
 from dash import html
-from gov_uk_dashboards.components.plotly import download_button_with_icon
+from gov_uk_dashboards.components.dash import download_button_with_icon
 
 
 def create_download_data_button(button_id_name: str) -> html.Div:

{gov_uk_dashboards-13.5.2/gov_uk_dashboards/components/plotly → gov_uk_dashboards-15.0.0/gov_uk_dashboards/components/dash}/filter_panel.py

@@ -2,7 +2,7 @@
 from typing import Optional
 from dash import html
 
-from gov_uk_dashboards.components.plotly.heading import heading2
+from gov_uk_dashboards.components.dash.heading import heading2
 from .collapsible_panel import collapsible_panel
 from .row_component import row_component
 

{gov_uk_dashboards-13.5.2/gov_uk_dashboards/components/plotly → gov_uk_dashboards-15.0.0/gov_uk_dashboards/components/dash}/table.py

@@ -2,8 +2,8 @@
 from typing import Optional
 from pandas import DataFrame
 from dash import html, dcc
-from gov_uk_dashboards.components.plotly.card import card
-from gov_uk_dashboards.components.plotly.paragraph import paragraph
+from gov_uk_dashboards.components.dash.card import card
+from gov_uk_dashboards.components.dash.paragraph import paragraph
 
 # from gov_uk_dashboards.components.plotly.row_component import row_component
 

{gov_uk_dashboards-13.5.2/gov_uk_dashboards/components → gov_uk_dashboards-15.0.0/gov_uk_dashboards/components/helpers}/display_chart_or_table_with_header.py

@@ -2,14 +2,14 @@
 
 from dash import html
 from dash.development.base_component import Component
-from gov_uk_dashboards.components.create_download_chart_button import (
+
+from gov_uk_dashboards.components.dash.create_download_chart_button import (
     create_download_chart_button,
 )
-from gov_uk_dashboards.components.create_download_data_button import (
+from gov_uk_dashboards.components.dash.create_download_data_button import (
     create_download_data_button,
 )
-
-from gov_uk_dashboards.components.plotly.heading import HeadingSizes
+from gov_uk_dashboards.components.dash.heading import HeadingSizes
 
 
 def display_chart_or_table_with_header(

{gov_uk_dashboards-13.5.2/gov_uk_dashboards/lib → gov_uk_dashboards-15.0.0/gov_uk_dashboards/components/helpers}/plotting_helper_functions.py

@@ -27,3 +27,20 @@ def get_legend_configuration(itemclick=True, itemdoubleclick=True):
         "itemclick": "toggle" if itemclick else False,
         "itemdoubleclick": "toggle" if itemdoubleclick else False,
     }
+
+
+def get_rgba_from_hex_colour_and_alpha(hex_code: str, alpha: float = 1.0) -> str:
+    """Get the rgba string corresponding to a hex-code colour and its alpha (opacity)
+
+    Args:
+        hex_code (str): hex code for converting (with #), e.g. "#00FF00"
+        alpha (float, optional): Desired transparency from 0 to 1. Defaults to 1.0.
+
+    Returns:
+        str: rgba string
+    """
+    if hex_code[0] != "#" or len(hex_code) != 7:
+        raise ValueError
+    rgb_colour = tuple(int(hex_code[i : i + 2], 16) for i in (1, 3, 5))
+
+    return f"rgba{rgb_colour + (alpha,)}"

{gov_uk_dashboards-13.5.2 → gov_uk_dashboards-15.0.0}/gov_uk_dashboards/components/plotly/choropleth_map.py

@@ -7,7 +7,7 @@ from dash import dcc
 from gov_uk_dashboards.constants import DEFAULT_COLOURSCALE
 
 from gov_uk_dashboards import colours
-from gov_uk_dashboards.components.display_chart_or_table_with_header import (
+from gov_uk_dashboards.components.helpers.display_chart_or_table_with_header import (
     display_chart_or_table_with_header,
 )
 

gov_uk_dashboards-15.0.0/gov_uk_dashboards/components/plotly/enums.py

@@ -0,0 +1,34 @@
+"""Classes to be used for defined enums and type structures"""
+
+from enum import Enum
+from typing import TypedDict
+
+
+class XAxisFormat(Enum):
+    """Enum for date format on x axis"""
+
+    YEAR = "year"
+    MONTH_YEAR = "month_year"
+    FINANCIAL_QUARTER = "financial_quarter"
+
+
+class TitleDataStructure(TypedDict):
+    """A TypedDict representing the structure of title_data"""
+
+    MAIN_TITLE: str
+    SUBTITLE: str
+
+
+class HoverDataStructure(TypedDict):
+    """A TypedDict representing the structure of hover_data"""
+
+    CUSTOM_DATA: list[str]
+    HOVER_TEXT_HEADERS: list[str]
+
+
+class HoverDataByTrace(TypedDict):
+    """A TypedDict representing hover_data organized by tracename"""
+
+    tracename: dict[
+        str, HoverDataStructure
+    ]  # Each tracename maps to a HoverDataStructure

{gov_uk_dashboards-13.5.2 → gov_uk_dashboards-15.0.0}/gov_uk_dashboards/components/plotly/stacked_barchart.py

@@ -1,8 +1,7 @@
 """stacked_barchart function"""
 
-from enum import Enum
 import math
-from typing import Optional, TypedDict
+from typing import Optional
 from dash import html
 import polars as pl
 
@@ -20,50 +19,27 @@ from gov_uk_dashboards.constants import (
     VALUE,
 )
 from gov_uk_dashboards.colours import AFAccessibleColours
-from gov_uk_dashboards.components.display_chart_or_table_with_header import (
+from gov_uk_dashboards.components.helpers.display_chart_or_table_with_header import (
     display_chart_or_table_with_header,
 )
-from gov_uk_dashboards.components.plotly.generate_dash_graph_from_figure import (
+from gov_uk_dashboards.components.helpers.generate_dash_graph_from_figure import (
     generate_dash_graph_from_figure,
 )
-from gov_uk_dashboards.lib.plotting_helper_functions import get_legend_configuration
+from gov_uk_dashboards.components.helpers.plotting_helper_functions import (
+    get_legend_configuration,
+)
+from gov_uk_dashboards.components.plotly.enums import (
+    HoverDataByTrace,
+    TitleDataStructure,
+    XAxisFormat,
+)
 from gov_uk_dashboards.formatting.human_readable import format_as_human_readable
 
-from gov_uk_dashboards.lib.update_layout_bgcolor_margin import (
+from gov_uk_dashboards.components.helpers.update_layout_bgcolor_margin import (
     update_layout_bgcolor_margin,
 )
 
 
-class XAxisFormat(Enum):
-    """Enum for date format on x axis"""
-
-    YEAR = "year"
-    MONTH_YEAR = "month_year"
-    FINANCIAL_QUARTER = "financial_quarter"
-
-
-class TitleDataStructure(TypedDict):
-    """A TypedDict representing the structure of title_data"""
-
-    MAIN_TITLE: str
-    SUBTITLE: str
-
-
-class HoverDataStructure(TypedDict):
-    """A TypedDict representing the structure of hover_data"""
-
-    CUSTOM_DATA: list[str]
-    HOVER_TEXT_HEADERS: list[str]
-
-
-class HoverDataByTrace(TypedDict):
-    """A TypedDict representing hover_data organized by tracename"""
-
-    tracename: dict[
-        str, HoverDataStructure
-    ]  # Each tracename maps to a HoverDataStructure
-
-
 class StackedBarChart:
     """Class for use in generating stacked bar charts."""