Shared components library for Great services.
Project description
directory-components
Reusable components used across the GREAT platform for the Department for International Trade.
Installation
pip install directory-components
Development
$ git clone https://github.com/uktrade/directory-components
$ cd directory-components
$ [create virtual environment and activate]
$ make install_requirements
To test cookies locally add this to your /etc/hosts:
127.0.0.1 components.trade.great
Then visit the demo at components.trade.great:9013
Commands
Command | Description |
---|---|
make clean | Delete pyc files |
make pytest | Run all tests |
make pytest test_foo.py | Run all tests in file called test_foo.py |
make pytest -- --last-failed` | Run the last tests to fail |
make pytest -- -k foo | Run the test called foo |
make pytest -- | Run arbitrary pytest command |
make flake8 | Run linting |
make manage | Run arbitrary management command |
make webserver | Run the demo development web server |
make requirements | Compile the requirements file |
make install_requirements | Installed the compile requirements file |
make css | Compile scss to css |
make publish | Publish the package to PyPI |
Features
Environment variables
Environment variable | Notes |
---|---|
FEATURE_MAINTENANCE_MODE_ENABLED |
Controls MaintenanceModeMiddleware . |
FEATURE_FLAGS |
Place to store the service's feature flags. |
DIRECTORY_COMPONENTS_VAULT_DOMAIN |
Hashicorp vault domain. For diffing vaults. |
DIRECTORY_COMPONENTS_VAULT_ROOT_PATH |
Hashicorp vault root path. For diffing vaults. |
DIRECTORY_COMPONENTS_VAULT_PROJECT |
Hashicorp vault project. For diffing vaults. |
DIRECTORY_COMPONENTS_VAULT_IGNORE_SETTINGS_REGEX |
Settings to ignore when diffing vaults. |
- add env directory to demo/conf
- add dev file to env
- add below to env/dev file: SECRET_KEY=debug DEBUG=true
Middleware
Middleware can be found in directory_components.middleware.FooBar
.
Middleware | Notes |
---|---|
MaintenanceModeMiddleware |
Redirects to http://sorry.great.gov.uk if FEATURE_MAINTENANCE_MODE_ENABLED is true . |
NoCacheMiddlware |
Prevents any page in the service from caching pages of logged in users. |
PrefixUrlMiddleware |
Redirects use from unprefixed url to prefixed url. |
Context processors
Middleware can be found in directory_components.context_processors.foo_bar
.
Processor | Context variable name | Notes |
---|---|---|
sso_processor |
Exposes the state of the SSO user. | |
analytics |
directory_components_analytics |
GA details. Used by base template. |
header_footer_processor |
header_footer_urls |
Urls used by base template's header and footer. |
urls_processor |
directory_components_urls |
More urls used by base template's header and footer. |
feature_flags |
feature_flags |
Exposes the service's feature flags. |
Exception handlers
Add the following to your urls.py for directory components templates to be used on 404 and 500
handler404 = 'directory_components.views.handler404'
handler500 = 'directory_components.views.handler500'
Without doing this the 500 and 400 pages would not receive context data provided by context processors
Auto update services dependency
To automatically update the dependences of services that use this library call the following command:
$ make update
Settings janitor
Management commands are provided to assist in the maintenance of settings. Install by pip install directory-components[janitor]
and then add the following to settings.py
:
if some_predicate_is_met: # feature flagged so it's not used in prod
INSTALLED_APPS.append('directory_components.janitor')
Diff environments
You can diff the vaults of two environments by running the following.
manage.py environment_diff \
--token=<token> \
--domain=<domain> \
--root=<root> \
--project=<project> \
--environment_a=<environment_a> \
--environment_b=<environment_b>
For simplicity once you set the DIRECTORY_COMPONENTS_VAULT_DOMAIN
, DIRECTORY_COMPONENTS_VAULT_PROJECT
, and DIRECTORY_COMPONENTS_VAULT_ROOT_PATH
that simplifies to
manage.py environment_diff \
--token=<token> \
--environment_a=<environment_a> \
--environment_b=<environment_b>
Detect settings orphans
You can detect settings that are either unused in the codebase, redundant because they're explicitly set to the default django value, or obsolete because they're set in the vault but not used anywhere:
manage.py settings_shake \
--token=<token> \
--root=<root> \
--domain=<domain> \
--project=<project> \
--environment=<environment>
For simplicity once you set the DIRECTORY_COMPONENTS_VAULT_DOMAIN
, DIRECTORY_COMPONENTS_VAULT_PROJECT
, and DIRECTORY_COMPONENTS_VAULT_ROOT_PATH
that simplifies to
manage.py settings_shake \
--token=<token> \
--environment=<environment>
Publish to PyPI
The package should be published to PyPI on merge to master. If you need to do it locally then get the credentials from rattic and add the environment variables to your host machine:
Setting |
---|
DIRECTORY_PYPI_USERNAME |
DIRECTORY_PYPI_PASSWORD |
Then run the following command:
make publish
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for directory_components-33.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2902b8e55d623d327b4f1352272f892a70c637d97fbd078877cb29c10da9b22a |
|
MD5 | 30057ddde410291bd901be431af571c2 |
|
BLAKE2b-256 | a2d2209d23810e724c5b8c01d2ed5b3ae2c356f9ecd3427f02f80b24e441092a |