This package implements components from the GOV.UK design system in Shiny for Python
Where this documentation refers to the root folder we mean where this README.md is
located.
Add a summary of your project here.
To start using this project, first make sure your system meets its requirements.
It's suggested that you install this package and its requirements within a virtual environment.
- Python 3.12+ installed
- to have loaded environment variables from
.env
Contributors have some additional requirements - please see our contributing guidance.
Whilst in the root folder, in a terminal, you can install the package and its Python dependencies using:
python -m pip install -U pip setuptools
pip install -e .To install the contributing requirements, use:
python -m pip install -U pip setuptools
pip install -e .[dev]
pre-commit installThis installs an editable version of the package. This means that when you update the package code you do not have to reinstall it for the changes to take effect. This saves a lot of time when you test your code.
Remember to update the setup and requirement files inline with any changes to your package.
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.
If you want to help us build and improve pyshinygovstyle, please take a look at our
contributing guidelines.
This project structure is based on the govcookiecutter template project.