Gov UK dashboards

This package contains functionality which is common to UK Government plotly dashboards.

Background
Install
Usage
Updating
Trying out changes to the package from other repositories
License

Background

This package is to enable quicker development of government data dashboards, such as the government colour schemes and plotly components.

Install

For installation using pip:

pip install gov-uk-dashboards

or for a specific version:

pip install gov-uk-dashboards~=6.7.0

For installation using conda, paste the following code into the environment configuration file:

 - pip:
     - gov-uk-dashboards~=6.7.0

Usage

Using Government dashboard template with dash:

import dash
from gov_uk_dashboards.template import read_template

app = dash.Dash(__name__, suppress_callback_exceptions=True)
app.index_string = read_template()

For colours:

from gov_uk_dashboards.colours import GovUKColours

GovUKColours.DLUHC_BLUE.value

For components:

from gov_uk_dashboards.components.plotly import banners

banners.message_banner('category','message')

For formatting:

from gov_uk_dashboards.formatting.human_readable import format_as_human_readable

format_as_human_readable(1200,prefix='£')

For figures:

from gov_uk_dashboards import figures

chart_data = figures.ChartData(
    dataframe,
    x_column = "Date",
    y_column = "Value",
    category_column = "Category"
)

line_chart = figures.line_chart(
    data = chart_data,
    title = "Chart title"
    line_style = {
        "Category 1": figures.format.LineFormat(
            color = "#000000",
            dash_pattern = figures.enums.DashPatterns.SOLID,
        ),
    }
)

Updating the CSS

We use SCSS to generate our CSS - NEVER directly alter the dashboard.css file in the assets folder. To update CSS:

Add your changes to dashboard.scss in the sccs folder
Run npm install if you haven't recently (/ever)
Run npm run sass to generate CSS from SCSS
Change package version in setup.py
Push your changes to a new branch
Try new CSS on dashboard repo using pip install git+https://github.com/communitiesuk/pkg_gov_uk_dashboards.git@

Updating govuk-frontend CSS

Update govuk-frontend version in package.json
Run npm run sass to generate CSS from SCSS
Follow steps above to test new CSS on dashboard repo

Updating the package

When making changes to the package, the following should be done:

Update version in setup.py accordingly
- Style: Major.Minor.Patch, e.g. 1.2.3
- Major - any breaking changes to previous functionality.
- Minor - additional functionality that doesn't effect backward compatibility. When updated the patch version should be reset to zero. eg. 2.3.1 goes to 2.4.0 for minor update.
- Patch - bug fixes that don't effect backward compatibility. For more information see here
After merging with main, go here to add a new version tag.
- Click 'Draft a new release'
- Under 'Choose a tag' dropdown, enter 'v<version number>'. Click 'Create new tag'
- Give the tag a release title, this should be the same as the tag name.
- Give a bullet point list of changes in the "Describe this release" section.
- Make sure 'Target' is set to 'main'.
- Click 'Publish release'.
- The release will be uploaded to PyPI.org automatically.
Update the package references within projects where the package is used, by following the Installation section.

Trying out changes to the package from other repositories

When you want to make changes to the package to use in another repository, it can be useful to see what changes would look like before commiting to the package repo. You can do this by making changes directly to the package files in the conda environment of the repository you're working in.

Open the file you wish to change in the conda environment
Do this by clicking into functions from the package in your IDE or by finding the file you wish to change in your file system, e.g. .../anaconda3/envs/*repo*/lib/python3.9/site-packages/gov_uk_dashboards/components/...
Make the changes to the package file and you should see the changes in your localhost on refresh
If you want to undo your changes: pip install --upgrade --force-reinstall <package_name>~=<package_version>

When you're happy, you can make the changes on a branch in the package repo and install it locally to check it works as expected when imported before merging into main in the package repo:

You can update the environment.yml to point at your branch or run pip install with the url: git+https://github.com/communitiesuk/pkg_gov_uk_dashboards.git@<your-branch>

License

Release files for gov-uk-dashboards 12.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gov-uk-dashboards 12.3.1
File	Size	Uploaded
gov_uk_dashboards-12.3.1.tar.gz	4.4 MB	Nov 20, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for gov-uk-dashboards 12.3.1
File	Interpreter	ABI	Platform	Reset
gov_uk_dashboards-12.3.1-py3-none-any.whl 4.4 MB Nov 20, 2024	Python 3	none	any	Details

Total release size:8.7 MB

Release files / gov_uk_dashboards-12.3.1.tar.gz

Download URL	gov_uk_dashboards-12.3.1.tar.gz
Size	4.4 MB
Tags	Source
SHA-256 checksum How to use checksums	`d35ad9ae0391c1ac7975b2da7636a746ea110535eb51271dd770ff43797d93fa`
BLAKE2b-256 checksum How to use checksums	`f07ff19ea17bd03e67f89825bbbb028de275a42b7513b057fe955dc7dc3eaa26`
Upload date	Nov 20, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.7`

Release files / gov_uk_dashboards-12.3.1-py3-none-any.whl

Download URL	gov_uk_dashboards-12.3.1-py3-none-any.whl
Size	4.4 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`797ae29391b2cf52e65a689963911d51706373c2182628272e9cec7abbdbc9df`
BLAKE2b-256 checksum How to use checksums	`0de79c004d9877449d0935176e03a427d5a132c29bf14a994a4fe07f15aa0107`
Upload date	Nov 20, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.7`